TXMLBroker Members

The following tables list the members exposed by TXMLBroker.

	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.
	AS_ApplyUpdates	This is AS_ApplyUpdates, a member of class TXMLBroker.
	AS_FetchParams	This is AS_FetchParams, a member of class TXMLBroker.
	AS_GetRecords	This is AS_GetRecords, a member of class TXMLBroker.
	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.
	CheckInactive	This is CheckInactive, a member of class TXMLBroker.
	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.
	DispatchEnabled
	DispatchMask
	DispatchMethodType
	DispatchRequest
	GetAppServer	This is GetAppServer, a member of class TXMLBroker.
	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	This is GetConnected, a member of class TXMLBroker.
	GetErrorResponse	This is GetErrorResponse, a member of class TXMLBroker.
	GetHasAppServer	This is GetHasAppServer, a member of class TXMLBroker.
	GetIDsOfNames	Maps a single member and an optional set of argument names to a corresponding set of integer dispatch identifiers (dispIDs).
	GetNotify	This is GetNotify, a member of class TXMLBroker.
	GetNotifyCount	This is GetNotifyCount, a member of class TXMLBroker.
	GetOwner	Returns the owner of a component.
	GetOwner	Returns the owner of an object.
	GetProducerName	This is GetProducerName, a member of class TXMLBroker.
	GetRedirect	This is GetRedirect, a member of class TXMLBroker.
	GetResponse	This is GetResponse, a member of class TXMLBroker.
	GetTypeInfo	Retrieves the type information for an object.
	GetTypeInfoCount	Returns the number of type information interfaces that an object provides (either 0 or 1).
	GetXMLStream	This is GetXMLStream, a member of class TXMLBroker.
	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.
	SendConnectEvent	This is SendConnectEvent, a member of class TXMLBroker.
	SetAncestor	Clears or sets csAncestor state in the component's ComponentState property.
	SetAppServer	This is SetAppServer, a member of class TXMLBroker.
	SetChildOrder	Sets the visual ordering of a child control.
	SetConnected	This is SetConnected, a member of class TXMLBroker.
	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.
	SetParams	This is SetParams, a member of class TXMLBroker.
	SetParentComponent	Sets the parent component.
	SetProviderName	This is SetProviderName, a member of class TXMLBroker.
	SetReconcileProducer	This is SetReconcileProducer, a member of class TXMLBroker.
	SetRemoteServer	This is SetRemoteServer, a member of class TXMLBroker.
	SetWebDispatch	This is SetWebDispatch, a member of class TXMLBroker.
	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 interface.
	_Release	Decrements the reference count for this interface.
	AddNotify	Adds an object to the Notify property list.
	AfterConstruction	Responds after the last constructor has executed.
	ApplyXMLUpdates	Sends an XML delta packet of updated, inserted, and deleted records to the provider on the application server for writing to the database.
	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.
	Create	Creates a new TXMLBroker object.
	DefaultHandler	Provides the interface for a method that processes message records.
	Destroy	Frees the memory associated with the TXMLBroker object.
	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.
	FetchParams	Retrieves parameter values from the application server.
	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.
	GetDelta	Extracts an XML delta packet from an HTTP request message.
	GetEnumerator	Returns a TComponent enumerator.
	GetErrorCount	Returns the number of errors in the delta packet returned by GetErrors.
	GetErrors	Returns the XML delta packet (if any) that describes the errors that occurred when applying updates.
	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.
	GetXMLRecords	Retrieves an XML data packet from the application server.
	HasParent	Verifies whether the component has a parent.
	HTMLSubmitFormName	Returns the name of the HTML form that submits updates to the XML broker.
	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.
	MasterRowSetVarName	Returns the name of the javascript variable for the XML broker's dataset.
	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.
	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
	RemoveNotify	Removes an object to the Notify property list.
	RequestRecords	Returns an XML data packet from the application server.
	RequestUpdate	Responds to an HTTP update request.
	RowSetVarName	Returns the name of the javascript variable for the XML broker's dataset.
	SafeCallException	Handles exceptions in methods declared using the safecall calling convention.
	SafeCallException	Handles exceptions in methods declared using the safecall calling convention.
	SetProvider	Associates the XML broker with a provider in the same process space.
	SetSubComponent	Identifies whether the component is a subcomponent.
	SubmitFormVarName	Returns the name of the variable that refers to the HTML form named by HTMLSubmitFormName.
	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	Provides access to the interface the XML broker uses to communicate 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.
	DesignInfo	Contains information used by the Form designer.
	Enabled
	HasAppServer	Indicates whether the XML broker has an IAppServer interface for communicating with its provider.
	Mask
	MethodType	This is MethodType, a member of class IWebDispatch.
	Notify	Lists the objects that are notified when any properties affecting the XML broker's connection to its provider change.
	NotifyCount	Indicates the number of objects in the Notify property list.
	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
	AfterDispatch	Occurs after the XML broker generates the content of a response message.
	BeforeDispatch	Occurs when the XML broker receives an HTTP request message.
	OnGetErrorResponse	Occurs when there are errors applying updates to the application server.
	OnGetResponse	Occurs when there are no errors applying updates to the application server.
	OnRequestRecords	Occurs when the XML broker needs to fetch a data packet from its associated provider.
	OnRequestUpdate	Occurs immediately before the XML broker applies updates to the application server.

Published Properties

	Name	Description
	Connected	Determines whether the XML broker has an active connection to the provider that supplies its data and applies its updates.
	MaxErrors	Specifies the maximum number of update errors allowed before aborting an update operations.
	MaxRecords	Specifies the maximum number of records that can appear in XML data packets.
	Name	Specifies the name of the component as referenced in code.
	Params	Contains parameter values that are sent to or retrieved from the application server.
	ProviderName	Specifies the name of a registered provider from the application server.
	ReconcileProducer	Specifies the producer that generates response message content when an update generates errors.
	RemoteServer	Specifies the connection component that this XML broker uses to connect to an application server.
	Tag	Stores an integer value as part of a component.
	WebDispatch	Lets the Web dispatcher identify what HTTP messages should be forwarded to the XML broker.

What do you think about this topic? Send feedback!