TCOMConnection Members

The following tables list the members exposed by TCOMConnection.

	Name	Description
	OnGetUsername	Occurs immediately before the remote login dialog.

Protected Fields

	Name	Description
	FComponentStyle	FComponentStyle is the field of the ComponentStyle read-only property.

Protected Methods

	Name	Description
	_AddRef	Called when an application uses a component interface.
	_Release	Called when an application releases a component interface.
	AssignTo	Copies the properties of an object to a destination object.
	ChangeName	Sets the private, internal storage for the Name property to the string passed in NewName.
	DefineProperties	Designates methods for storing an object's unpublished data on a stream such as a form file.
	DefineProperties	Provides an interface for a method that reads and writes otherwise unpublished data.
	DoConnect	Connects to an application server.
	DoDisconnect	Provides the interface for a method that terminates the connection.
	DoDisconnect	Drops a connection to an application server.
	GetAppServer	Returns the value of the AppServer property.
	GetChildOwner	Returns the owner of a child component being read from a stream.
	GetChildParent	Returns the parent, or if there is no parent, returns the owner of a child component being read from a stream.
	GetChildren	Enumerates all child components.
	GetConnected	Returns the value of the Connected property.
	GetConnected	Returns the value of the Connected property.
	GetDataSet	Returns a dataset, given its index in the DataSets property array.
	GetDataSetCount	Returns the value of the DataSetCount property.
	GetIDsOfNames	Maps a single member and an optional set of argument names to a corresponding set of integer dispatch identifiers (dispIDs).
	GetOwner	Returns the owner of a component.
	GetOwner	Returns the owner of an object.
	GetServerCLSID	Returns the GUID for the application server.
	GetTypeInfo	Retrieves the type information for an object.
	GetTypeInfoCount	Returns the number of type information interfaces that an object provides (either 0 or 1).
	Invoke	Provides access to Automation properties and methods when the component wraps an Automation object.
	Loaded	Initializes the component after the form file has been read into memory.
	Loaded	Initializes the connection component after all objects in the form or data module have been loaded.
	Notification	Forwards notification messages to all owned components.
	Notification	Responds when other objects are created or destroyed.
	PaletteCreated	Responds when the component is created from the component palette.
	QueryInterface	Returns a reference to a specified interface if the object supports that interface.
	ReadState	Reads the state of the component.
	RegisterClient	Registers an object that uses the connection component.
	SendConnectEvent	Informs all registered clients that use the connection component when a connection is opened or closed.
	SetAncestor	Clears or sets csAncestor state in the component's ComponentState property.
	SetAppServer	Sets the AppServer property.
	SetChildOrder	Sets the visual ordering of a child control.
	SetConnected	Sets the Connected property.
	SetDesigning	Ensures that components inserted at design time have their design-mode flag set.
	SetDesignInstance	Ensures that components inserted at design time have their design-mode flag set.
	SetInline	Sets the csInline bit of the component's ComponentState property
	SetName	Sets the value of the Name property.
	SetParentComponent	Sets the parent component.
	UnRegisterClient	Removes a registered client so that it is no longer associated with the connection component.
	Updated	Clears the csUpdating state in the component's ComponentState property when the component finishes updating.
	UpdateRegistry	Provides the interface for a method that adds type library and version information to the Registry on components that implement COM interfaces.
	Updating	Sets the csUpdating state in the component's ComponentState property.
	ValidateContainer	Determines whether an object can be inserted into a container.
	ValidateInsert	Provides the interface for a method that validates an child component before it is inserted.
	ValidateRename	Ensures that renaming an owned component does not create name conflict.
	WriteState	Writes the state of the component.

Protected Properties

	Name	Description
	ObjectBroker	Specifies an Object Broker that allows the connection component to choose from several application servers.
	StreamedConnected	Indicates whether the Connected property was true when the connection component was loaded from a stream.

Public Events

	Name	Description
	AfterConnect	Occurs after a connection is established.
	AfterDisconnect	Occurs after the connection closes.
	BeforeConnect	Occurs immediately before establishing a connection.
	BeforeDisconnect	Occurs immediately before the connection closes.
	OnLogin	Occurs when a communication channel opens to the server.

Public Methods

	Name	Description
	_AddRef	Increments the reference count for this interface.
	_Release	Decrements the reference count for this interface.
	AfterConstruction	Responds after the last constructor has executed.
	Assign	Copies the contents of another, similar object.
	BeforeDestruction	Performs any necessary actions before the first destructor is called.
	BeforeDestruction	Responds before the first destructor executes.
	ClassInfo	Returns a pointer to the runtime type information (RTTI) table for the object type.
	ClassName	Returns a string indicating the type of the object instance (as opposed to the type of the variable passed as an argument).
	ClassNameIs	Determines whether an object is of a specific type.
	ClassParent	Returns the type of the immediate ancestor of a class.
	ClassType	Returns the class reference for the object's class.
	CleanupInstance	Performs finalization on long strings, variants, and interface variables within a class.
	Close	Closes the connection.
	Create	Allocates memory and constructs a safely initialized instance of a component.
	Create	Creates an instance of TCustomConnection.
	Create	Creates an instance of a remote server component.
	Create	Creates an instance of a dispatch connection component.
	Create	Constructs an object and initializes its data before the object is first used.
	DefaultHandler	Provides the interface for a method that processes message records.
	Destroy	Disposes of the component and its owned components.
	Destroy	Destroys the TPersistent instance and frees its memory.
	Destroy	Destroys the instance of a connection component.
	Destroy	Disposes of an object instance.
	DestroyComponents	Destroys all owned components.
	Destroying	Indicates that the component and its owned components are about to be destroyed.
	Dispatch	Calls message-handling methods for the object, based on the contents of the Message parameter.
	Equals	Checks if the current instance and the parameter are equal.
	ExecuteAction	Executes an action.
	FieldAddress	This is the overview for the FieldAddress method overload.
	FindComponent	Indicates whether a given component is owned by the component.
	Free	Destroys an object and frees its associated memory, if necessary.
	FreeInstance	Deallocates memory allocated by a previous call to the System::TObject::NewInstance method.
	FreeNotification	Ensures that AComponent is notified that the component is going to be destroyed.
	FreeOnRelease	Frees the interface reference for components that were created from COM classes.
	GetComponent	Returns a reference to the component associated by the implementing class.
	GetEnumerator	Returns a TComponent enumerator.
	GetHashCode	Returns an integer containing the hash code.
	GetInterface	Retrieves a specified interface.
	GetInterfaceEntry	Returns the entry for a specific interface implemented in a class.
	GetInterfaceTable	Returns a pointer to a structure containing all of the interfaces implemented by a given class.
	GetNamePath	Returns a string used by the Object Inspector.
	GetNamePath	Returns the name of the object as it appears in the Object Inspector.
	GetParentComponent	Returns the containing Component.
	GetProviderNames	Executes a callback for all provider objects on the application server.
	GetServer	Returns the IAppServer interface of the application server.
	GetServer	Returns the IAppServer interface of the application server.
	GetServerList	Returns a list of application servers (remote data modules) to which the component can connect.
	GetServerList	Returns a list of remote data modules to which the component can connect.
	HasParent	Verifies whether the component has a parent.
	InheritsFrom	Determines the relationship of two object types.
	InitInstance	Initializes a newly allocated object instance to all zeros and initializes the instance's virtual method table pointer.
	InsertComponent	Establishes the component as the owner of a specified component.
	InstanceSize	Returns the size in bytes of each instance of the object type.
	IsImplementorOf	Indicates whether the component implements a specified interface.
	MethodAddress	This is the overview for the MethodAddress method overload.
	MethodName	Returns the name of a class method by address.
	NewInstance	Allocates memory for an instance of an object type and returns a pointer to that new instance.
	Open	Opens the connection.
	QueryInterface	Returns a reference to a specified interface if the object supports that interface.
	ReferenceInterface	Establishes or removes internal links that cause this component to be notified when the implementer of a specified interface is destroyed.
	RemoveComponent	Removes a specified component specified from the component's Components list.
	RemoveFreeNotification	Disables destruction notification that was enabled by FreeNotification
	SafeCallException	Handles exceptions in methods declared using the safecall calling convention.
	SafeCallException	Handles exceptions in methods declared using the safecall calling convention.
	SetSubComponent	Identifies whether the component is a subcomponent.
	ToString	Returns a string containing the class name.
	UnitName	Returns a string containing the unit name.
	UpdateAction	Updates the state of an action.

Public Properties

	Name	Description
	AppServer	Contains the interface for communicating with the application server.
	ComObject	Specifies the interface reference implemented by the component.
	ComponentCount	Indicates the number of components owned by the component.
	ComponentIndex	Indicates the position of the component in its owner's Components property array.
	Components	Lists all components owned by the component.
	ComponentState	Describes the current state of the component, indicating when a component needs to avoid certain actions.
	ComponentStyle	Governs the behavior of the component.
	Connected	Determines whether a connection has been established to the remote source of data.
	DataSetCount	Indicates the number of datasets associated with the connection component.
	DataSets	Lists the datasets currently using this connection component.
	DesignInfo	Contains information used by the Form designer.
	LoginPrompt	Specifies whether a login dialog appears immediately before opening a new connection.
	Owner	Indicates the component that is responsible for streaming and freeing this component.
	VCLComObject	Represents information used internally by components that support COM.

Published Events

	Name	Description
	AfterConnect	Occurs after a connection is established.
	AfterDisconnect	Occurs after the connection closes.
	BeforeConnect	Occurs immediately before establishing a connection.
	BeforeDisconnect	Occurs immediately before the connection closes.
	OnGetUsername	Occurs immediately before the remote login dialog.
	OnLogin	Occurs when a communication channel opens to the server.

Published Properties

	Name	Description
	Connected	Indicates whether the TDispatchConnection object is connected to an application server.
	LoginPrompt	Specifies whether a login dialog appears immediately before opening a new connection.
	Name	Specifies the name of the component as referenced in code.
	ServerGUID	Specifies the GUID of the application server with which to connect.
	ServerName	Specifies the name of the application server with which to connect.
	Tag	Stores an integer value as part of a component.

What do you think about this topic? Send feedback!