indexing
	description: "Networking constants"
	legal: "See notice at end of class."
	status: "See notice at end of class."
	date: "$Date: 2006-01-22 18:25:44 -0800 (Sun, 22 Jan 2006) $"
	revision: "$Revision: 56675 $"

class interface
	WEL_NETWORKING_CONSTANTS

create 
	default_create
			-- Process instances of classes with no creation clause.
			-- (Default: do nothing.)
			-- (from ANY)

feature -- Access

	generating_type: STRING_8
			-- Name of current object's generating type
			-- (type of which it is a direct instance)
			-- (from ANY)

	generator: STRING_8
			-- Name of current object's generating class
			-- (base class of the type of which it is a direct instance)
			-- (from ANY)
	
feature -- Comparison

	frozen deep_equal (some: ANY; other: like arg #1): BOOLEAN
			-- Are `some' and `other' either both void
			-- or attached to isomorphic object structures?
			-- (from ANY)
		ensure -- from ANY
			shallow_implies_deep: standard_equal (some, other) implies Result
			both_or_none_void: (some = Void) implies (Result = (other = Void))
			same_type: (Result and (some /= Void)) implies some.same_type (other)
			symmetric: Result implies deep_equal (other, some)

	frozen equal (some: ANY; other: like arg #1): BOOLEAN
			-- Are `some' and `other' either both void or attached
			-- to objects considered equal?
			-- (from ANY)
		ensure -- from ANY
			definition: Result = (some = Void and other = Void) or else ((some /= Void and other /= Void) and then some.is_equal (other))

	is_equal (other: like Current): BOOLEAN
			-- Is `other' attached to an object considered
			-- equal to current object?
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void
		ensure -- from ANY
			symmetric: Result implies other.is_equal (Current)
			consistent: standard_is_equal (other) implies Result

	frozen standard_equal (some: ANY; other: like arg #1): BOOLEAN
			-- Are `some' and `other' either both void or attached to
			-- field-by-field identical objects of the same type?
			-- Always uses default object comparison criterion.
			-- (from ANY)
		ensure -- from ANY
			definition: Result = (some = Void and other = Void) or else ((some /= Void and other /= Void) and then some.standard_is_equal (other))

	frozen standard_is_equal (other: like Current): BOOLEAN
			-- Is `other' attached to an object of the same type
			-- as current object, and field-by-field identical to it?
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void
		ensure -- from ANY
			same_type: Result implies same_type (other)
			symmetric: Result implies other.standard_is_equal (Current)
	
feature -- Status report

	conforms_to (other: ANY): BOOLEAN
			-- Does type of current object conform to type
			-- of `other' (as per Eiffel: The Language, chapter 13)?
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void

	same_type (other: ANY): BOOLEAN
			-- Is type of current object identical to type of `other'?
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void
		ensure -- from ANY
			definition: Result = (conforms_to (other) and other.conforms_to (Current))
	
feature -- Duplication

	copy (other: like Current)
			-- Update current object using fields of object attached
			-- to `other', so as to yield equal objects.
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void
			type_identity: same_type (other)
		ensure -- from ANY
			is_equal: is_equal (other)

	frozen deep_copy (other: like Current)
			-- Effect equivalent to that of:
			--		copy (`other' . deep_twin)
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void
		ensure -- from ANY
			deep_equal: deep_equal (Current, other)

	frozen deep_twin: like Current
			-- New object structure recursively duplicated from Current.
			-- (from ANY)
		ensure -- from ANY
			deep_equal: deep_equal (Current, Result)

	frozen standard_copy (other: like Current)
			-- Copy every field of `other' onto corresponding field
			-- of current object.
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void
			type_identity: same_type (other)
		ensure -- from ANY
			is_standard_equal: standard_is_equal (other)

	frozen standard_twin: like Current
			-- New object field-by-field identical to `other'.
			-- Always uses default copying semantics.
			-- (from ANY)
		ensure -- from ANY
			standard_twin_not_void: Result /= Void
			equal: standard_equal (Result, Current)

	frozen twin: like Current
			-- New object equal to `Current'
			-- twin calls copy; to change copying/twining semantics, redefine copy.
			-- (from ANY)
		ensure -- from ANY
			twin_not_void: Result /= Void
			is_equal: Result.is_equal (Current)
	
feature -- Basic operations

	frozen default: like Current
			-- Default value of object's type
			-- (from ANY)

	frozen default_pointer: POINTER
			-- Default value of type `POINTER'
			-- (Avoid the need to write `p'.default for
			-- some `p' of type `POINTER'.)
			-- (from ANY)

	default_rescue
			-- Process exception for routines with no Rescue clause.
			-- (Default: do nothing.)
			-- (from ANY)

	frozen do_nothing
			-- Execute a null action.
			-- (from ANY)
	
feature -- Connect constants

	connect_interactive: INTEGER_32 is 8
			-- If this flag is set, the operating system may interact with 
			-- the user for authentication purposes.
			--
			-- Declared in Windows as CONNECT_INTERACTIVE

	connect_localdrive: INTEGER_32 is 256
			-- If this flag is set, the connection was made using a local
			-- device redirection. If the lpAccessName parameter points to a
			-- buffer, the local device name is copied to the buffer.
			--
			-- Declared in Windows as CONNECT_LOCALDRIVE

	connect_prompt: INTEGER_32 is 16
			-- This flag instructs the system not to use any default settings
			-- for user names or passwords without offering the user the 
			-- opportunity to supply an alternative. This flag is ignored 
			-- unless CONNECT_INTERACTIVE is also set.
			--
			-- Declared in Windows as CONNECT_PROMPT

	connect_redirect: INTEGER_32 is 128
			-- This flag forces the redirection of a local device when making
			-- the connection.
			--
			-- If the lpLocalName member of NETRESOURCE specifies a local
			-- device to redirect, this flag has no effect, because the
			-- operating system still attempts to redirect the specified 
			-- device. When the operating system automatically chooses a local
			-- device, the lpAccessName parameter must point to a return
			-- buffer and the dwType member must not be equal to 
			-- RESOURCETYPE_ANY.
			--
			-- If this flag is not set, a local device is automatically chosen
			-- for redirection only if the network requires a local device to
			-- be redirected.
			--
			-- Declared in Windows as CONNECT_REDIRECT

	connect_update_profile: INTEGER_32 is 1
			-- This flag instructs the operating system to store the network
			-- resource connection. 
			--
			-- If this bit flag is set, the operating system automatically
			-- attempts to restore the connection when the user logs on. The
			-- system remembers only successful connections that redirect
			-- local devices. It does not remember connections that are
			-- unsuccessful or deviceless connections. (A deviceless
			-- connection occurs when lpLocalName is NULL or when it points
			-- to an empty string.)
			--
			-- If this bit flag is clear, the operating system does not
			-- automatically restore the connection at logon.
			--
			-- Declared in Windows as CONNECT_UPDATE_PROFILE
	
feature -- Generic constants

	max_path: INTEGER_32 is 260
			-- Maximum number of characters in full path
			--
			-- Declared in Windows as MAX_PATH
	
feature -- Net Errors

	error_access_denied: INTEGER_32 is 5
			-- Access to the network resource was denied.
			--
			-- Declared in Windows as ERROR_ACCESS_DENIED

	error_already_assigned: INTEGER_32 is 85
			-- The local device specified by the lpLocalName member is 
			-- already connected to a network resource.
			--
			-- Declared in Windows as ERROR_ALREADY_ASSIGNED

	error_bad_device: INTEGER_32 is 1200
			-- The value specified by lpLocalName is invalid.
			--
			-- Declared in Windows as ERROR_BAD_DEVICE

	error_bad_net_name: INTEGER_32 is 67
			-- The value specified by the lpRemoteName member is not
			-- acceptable to any network resource provider because the
			-- resource name is invalid, or because the named resource
			-- cannot be located.
			--
			-- Declared in Windows as ERROR_BAD_NET_NAME

	error_bad_provider: INTEGER_32 is 1204
			-- The value specified by the lpProvider member does not match
			-- any provider.
			--
			-- Declared in Windows as ERROR_BAD_PROVIDER

	error_cancelled: INTEGER_32 is 1223
			-- The attempt to make the connection was canceled by the user
			-- through a dialog box from one of the network resource
			-- providers, or by a called resource.
			--
			-- Declared in Windows as ERROR_CANCELLED

	error_extended_error: INTEGER_32 is 1208
			-- A network-specific error occurred. To obtain a description of
			-- the error, call the WNetGetLastError function.
			--
			-- Declared in Windows as ERROR_EXTENDED_ERROR

	error_invalid_address: INTEGER_32 is 487
			-- The caller passed in a pointer to a buffer that could not be
			-- accessed.
			--
			-- Declared in Windows as ERROR_INVALID_ADDRESS

	error_invalid_parameter: INTEGER_32 is 87
			-- This error is a result of one of the following conditions: 
			-- 1. The lpRemoteName member is NULL. In addition, lpAccessName
			--    is not NULL, but lpBufferSize is either NULL or points to
			--    zero. 
			-- 2. The dwType member is neither RESOURCETYPE_DISK nor
			--    RESOURCETYPE_PRINT. In addition, either CONNECT_REDIRECT
			--    is set in dwFlags and lpLocalName is NULL, or the
			--    connection is to a network that requires the redirecting
			--    of a local device. 
			--
			-- Declared in Windows as ERROR_INVALID_PARAMETER

	error_invalid_password: INTEGER_32 is 86
			-- The specified password is invalid and the CONNECT_INTERACTIVE
			-- flag is not set.
			--
			-- Declared in Windows as ERROR_INVALID_PASSWORD

	error_more_data: INTEGER_32 is 234
			-- The lpAccessName buffer is too small. 
			-- If a local device is redirected, the buffer needs to be large
			-- enough to contain the local device name. Otherwise, the
			-- buffer needs to be large enough to contain either the string
			-- pointed to by lpRemoteName, or the name of the connectable
			-- resource whose alias is pointed to by lpRemoteName. If this
			-- error is returned, then no connection has been made.
			--
			-- Declared in Windows as ERROR_MORE_DATA

	error_no_more_items: INTEGER_32 is 259
			-- The operating system cannot automatically choose a local
			-- redirection because all the valid local devices are in use.
			--
			-- Declared in Windows as ERROR_NO_MORE_ITEMS

	error_no_net_or_bad_path: INTEGER_32 is 1203
			-- The operation could not be completed, either because a
			-- network component is not started, or because the specified
			-- resource name is not recognized.
			--
			-- Declared in Windows as ERROR_NO_NET_OR_BAD_PATH

	error_no_network: INTEGER_32 is 1222
			-- The network is unavailable.
			--
			-- Declared in Windows as ERROR_NO_NETWORK
	
feature -- Net Resource constants

	resource_connected: INTEGER_32 is 1
			-- Enumerate currently connected resources.
			--
			-- Declared in Windows as RESOURCE_CONNECTED

	resource_display_type_domain: INTEGER_32 is 1
			-- The object should be displayed as a domain.
			--
			-- Declared in Windows as RESOURCEDISPLAYTYPE_DOMAIN

	resource_display_type_generic: INTEGER_32 is 0
			-- The method used to display the object does not matter.
			--
			-- Declared in Windows as RESOURCEDISPLAYTYPE_GENERIC

	resource_display_type_server: INTEGER_32 is 2
			-- The object should be displayed as a server.
			--
			-- Declared in Windows as RESOURCEDISPLAYTYPE_SERVER

	resource_display_type_share: INTEGER_32 is 3
			-- The object should be displayed as a share.
			--
			-- Declared in Windows as RESOURCEDISPLAYTYPE_SHARE

	resource_globalnet: INTEGER_32 is 2
			-- Enumerate all resources on the network.
			--
			-- Declared in Windows as RESOURCE_GLOBALNET

	resource_remembered: INTEGER_32 is 3
			-- Enumerate remembered (persistent) connections.
			--
			-- Declared in Windows as RESOURCE_REMEMBERED

	resource_type_any: INTEGER_32 is 0
			-- All resources
			--
			-- Declared in Windows as RESOURCETYPE_ANY

	resource_type_disk: INTEGER_32 is 1
			-- Disk resources
			--
			-- Declared in Windows as RESOURCETYPE_DISK

	resource_type_print: INTEGER_32 is 2
			-- Print resources
			--
			-- Declared in Windows as RESOURCETYPE_PRINT

	resource_usage_connectable: INTEGER_32 is 1
			-- The resource is a connectable resource
			--
			-- Declared in Windows as RESOURCEUSAGE_CONNECTABLE

	resource_usage_container: INTEGER_32 is 2
			-- The resource is a container resource
			--
			-- Declared in Windows as RESOURCEUSAGE_CONTAINER
	
feature -- Output

	io: STD_FILES
			-- Handle to standard file setup
			-- (from ANY)

	out: STRING_8
			-- New string containing terse printable representation
			-- of current object
			-- Was declared in ANY as synonym of tagged_out.
			-- (from ANY)

	print (some: ANY)
			-- Write terse external representation of `some'
			-- on standard output.
			-- (from ANY)

	frozen tagged_out: STRING_8
			-- New string containing terse printable representation
			-- of current object
			-- Was declared in ANY as synonym of out.
			-- (from ANY)
	
feature -- Platform

	operating_environment: OPERATING_ENVIRONMENT
			-- Objects available from the operating system
			-- (from ANY)
	
invariant
		-- from ANY
	reflexive_equality: standard_is_equal (Current)
	reflexive_conformance: conforms_to (Current)

indexing
	copyright: "Copyright (c) 1984-2006, Eiffel Software and others"
	license: "Eiffel Forum License v2 (see http://www.eiffel.com/licensing/forum.txt)"
	source: "[
		Eiffel Software
		356 Storke Road, Goleta, CA 93117 USA
		Telephone 805-685-1006, Fax 805-685-6869
		Website http://www.eiffel.com
		Customer support http://support.eiffel.com
	]"

end -- class WEL_NETWORKING_CONSTANTS