TSoapDataModule Members

The following tables list the members exposed by TSoapDataModule.

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

Protected Methods

	Name	Description
	ApplyUpdates	Applies updates received from a client using a specified provider.
	AS_ApplyUpdates	Applies updates received from a client using a specified provider.
	AS_DataRequest	Generates an OnAS_DataRequest event on the specified provider component.
	AS_Execute	AS_Executes the query or stored procedure bound to a specified provider.
	AS_GetParams	Fetches current parameter values from the dataset bound to a specified provider.
	AS_GetProviderNames	Returns a list of all the available providers on the SOAP data module.
	AS_GetRecords	Returns a data packet that contains the specified data.
	AS_RowRequest	Returns information from a specified record of the provider's dataset.
	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.
	DataRequest	Generates an OnDataRequest event on the specified provider component.
	DefineProperties	Designates methods for storing an object's unpublished data on a stream such as a form file.
	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.
	DoCreate	This is DoCreate, a member of class TDataModule.
	DoDestroy	This is DoDestroy, a member of class TDataModule.
	Execute	Executes the query or stored procedure bound to a specified provider.
	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.
	GetChildren	Enumerates all child components.
	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.
	GetParams	Fetches current parameter values from the dataset bound to a specified provider.
	GetProvider	Returns a registered provider component given its name.
	GetProviderNames	Returns a list of all the available providers on the SOAP data module.
	GetRecords	Returns a data packet that contains the specified data.
	GetTypeInfo	Retrieves the type information for an object.
	GetTypeInfoCount	Returns the number of type information interfaces that an object provides (either 0 or 1).
	HandleCreateException	This is HandleCreateException, a member of class TDataModule.
	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.
	Notification	Forwards notification messages to all owned components.
	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.
	ReadState	Reads the state of the component.
	RowRequest	Returns information from a specified record of the provider's dataset.
	SAS_ApplyUpdates	Applies updates received from a client using a specified provider.
	SAS_DataRequest	Generates an OnSAS_DataRequest event on the specified provider component.
	SAS_Execute	SAS_Executes the query or stored procedure bound to a specified provider.
	SAS_GetParams	Fetches current parameter values from the dataset bound to a specified provider.
	SAS_GetProviderNames	Returns a list of all the available providers on the SOAP data module.
	SAS_GetRecords	Returns a data packet that contains the specified data.
	SAS_RowRequest	Returns information from a specified record of the provider's dataset.
	SetAncestor	Clears or sets csAncestor state in the component's ComponentState property.
	SetChildOrder	Sets the visual ordering of a child control.
	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.
	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.

Public Methods

	Name	Description
	_AddRef	Increments the reference count for this data module's interface.
	_Release	Decrements the reference count for this data module's interface.
	AfterConstruction	Generates an OnCreate event.
	Assign	Copies the contents of another, similar object.
	BeforeDestruction	Generates an OnDestroy event.
	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.
	Create	Creates a SOAP data module instance.
	CreateNew	Creates an instance of a data module and registers with the global screen object.
	DefaultHandler	Provides the interface for a method that processes message records.
	Destroy	Frees a SOAP data module 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.
	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.
	Lock	Locks the SOAP data module so that it can't be locked by other threads.
	MethodAddress	This is the overview for the MethodAddress method overload.
	MethodName	Returns the name of a class method by address.
	NewInstance	Allocates memory for each instance of TSoapDataModule.
	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.
	RegisterProvider	Adds a provider to the list returned by AS_GetProviderNames.
	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.
	SetSubComponent	Identifies whether the component is a subcomponent.
	ToString	Returns a string containing the class name.
	UnitName	Returns a string containing the unit name.
	Unlock	Unlocks the SOAP data module after it was locked by a call to the Lock method.
	UnRegisterProvider	Removes a provider from the list returned by AS_GetProviderNames.
	UpdateAction	Updates the state of an action.

Public Properties

	Name	Description
	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.
	DesignInfo	Contains information used by the Form designer.
	DesignOffset	Specifies the design offset for the data module at design time.
	DesignSize	Specifies the design size for the data module at design time.
	Owner	Indicates the component that is responsible for streaming and freeing this component.
	ProviderCount	Indicates the number of providers registered with the SOAP data module.
	Providers	Lists the registered provider components that are contained in the SOAP data module.
	RefCount	Reference counts the data module's interface.
	VCLComObject	Represents information used internally by components that support COM.

Published Events

	Name	Description
	OnCreate	Occurs when an application instantiates a data module.
	OnDestroy	Occurs when the data module is about to be destroyed.

Published Properties

	Name	Description
	Name	Specifies the name of the component as referenced in code.
	OldCreateOrder	Specifies when OnCreate and OnDestroy events occur.
	Tag	Stores an integer value as part of a component.

What do you think about this topic? Send feedback!