THYUnmanagedRegisteredPlugin
Overview
The THYUnmanagedCrossPlatformRegisteredPlugin is support class that used internally
Location
- Unit: Hydra.Core.UnmanagedRegisteredPlugin.pas
- Ancestry: TInterfacedObject | THYFakeIDispatch | THYUnmanagedRegisteredPlugin
constructor Create
Creates a new instance of the class.
constructor Create(Descriptor: THYUnmanagedPluginDescriptor; CreatorFunc: THYCrossPlatformPluginCreatorFunc)
Parameters:
- Descriptor: Reference to a plugin descriptor.
- CreatorFunc: Creator function
CreatorFunc
property CreatorFunc: THYCrossPlatformPluginCreatorFunc read write
delegate: procedure CreatorFunc(out anInstance: IInterface)
Description
Gets user defined description of a plugin.
property Description: WideString read
Descriptor
Returns the descriptor of the plugin that is represented by the factory.
property Descriptor: THYUnmanagedPluginDescriptor read write
GetIDsOfNames protected stdcall (declared in THYFakeIDispatch)
Maps a single member and an optional set of argument names to a corresponding set of integer DISPIDs. Empty.
function GetIDsOfNames(const IID: TGUID; Names: Pointer; NameCount: Integer; LocaleID: Integer; DispIDs: Pointer): HResult
Parameters:
- IID: Reserved for future use. Must be IID_NULL.
- Names: The array of names to be mapped.
- NameCount: The count of the names to be mapped.
- LocaleID: The locale context in which to interpret the names.
- DispIDs: Caller-allocated array, each element of which contains an identifier (ID) corresponding to one of the names passed in the rgszNames array.
GetTypeInfo protected stdcall (declared in THYFakeIDispatch)
Retrieves the type information for an object, which can then be used to get the type information for an interface. Empty.
function GetTypeInfo(Index: Integer; LocaleID: Integer; out TypeInfo: ): HResult
Parameters:
- Index: Index of the type information to return.
- LocaleID: The locale identifier for the type information.
- TypeInfo: The requested type information object.
GetTypeInfoCount protected stdcall (declared in THYFakeIDispatch)
Retrieves the number of type information interfaces that an object provides (either 0 or 1). Empty
function GetTypeInfoCount(out Count: Integer): HResult
Parameters:
- Count: The number of type information interfaces provided by the object. If the object provides type information, this number is 1; otherwise the number is 0.
InterfaceSupportsErrorInfo protected stdcall (declared in THYFakeIDispatch)
Indicates whether an interface supports the IErrorInfo interface.
function InterfaceSupportsErrorInfo(const iid: TIID): HResult
Parameters:
- iid: An interface identifier (IID).
Invoke protected stdcall (declared in THYFakeIDispatch)
Provides access to properties and methods exposed by an object. Empty.
function Invoke(DispID: Integer; const IID: TGUID; LocaleID: Integer; Flags: Word; var Params: ; VarResult: Pointer; ExcepInfo: Pointer; ArgErr: Pointer): HResult
Parameters:
- DispID: Identifies the member.
- IID: Reserved for future use. Must be IID_NULL.
- LocaleID: The locale context in which to interpret arguments.
- Flags: Flags describing the context of the Invoke call.
- Params: Pointer to a DISPPARAMS structure containing an array of arguments, an array of argument DISPIDs for named arguments, and counts for the number of elements in the arrays.
- VarResult: Pointer to the location where the result is to be stored, or nil if the caller expects no result.
- ExcepInfo: Pointer to a structure that contains exception information.
- ArgErr: The index within rgvarg of the first argument that has an error.
MajorVersion
Gets major version of a plugin.
property MajorVersion: Integer read
MinorVersion
Gets minor version of a plugin.
property MinorVersion: Integer read
Name
Gets name of the plugin.
property Name: WideString read
ReferenceCount (declared in THYFakeIDispatch)
Gets the number of the references to this object.
property ReferenceCount: Integer read
RequiredPrivilege
Gets user defined string that holds privilages that is required to use an object.
property RequiredPrivilege: WideString read
SafeCallException override (declared in THYFakeIDispatch)
Handles exceptions in methods declared using the safecall calling convention.
function SafeCallException(ExceptObject: TObject; ExceptAddr: Pointer): HResult
Parameters:
- ExceptObject: Exception object.
- ExceptAddr: Addres of the exception.
UserData
Gets user defined data.
property UserData: WideString read
Description
Gets user defined description of a plugin.
property Description: WideString read
Descriptor
Returns the descriptor of the plugin that is represented by the factory.
property Descriptor: THYUnmanagedPluginDescriptor read write
MajorVersion
Gets major version of a plugin.
property MajorVersion: Integer read
MinorVersion
Gets minor version of a plugin.
property MinorVersion: Integer read
Name
Gets name of the plugin.
property Name: WideString read
ReferenceCount (declared in THYFakeIDispatch)
Gets the number of the references to this object.
property ReferenceCount: Integer read
RequiredPrivilege
Gets user defined string that holds privilages that is required to use an object.
property RequiredPrivilege: WideString read
UserData
Gets user defined data.
property UserData: WideString read
constructor Create
Creates a new instance of the class.
constructor Create(Descriptor: THYUnmanagedPluginDescriptor; CreatorFunc: THYCrossPlatformPluginCreatorFunc)
Parameters:
- Descriptor: Reference to a plugin descriptor.
- CreatorFunc: Creator function
GetIDsOfNames protected stdcall (declared in THYFakeIDispatch)
Maps a single member and an optional set of argument names to a corresponding set of integer DISPIDs. Empty.
function GetIDsOfNames(const IID: TGUID; Names: Pointer; NameCount: Integer; LocaleID: Integer; DispIDs: Pointer): HResult
Parameters:
- IID: Reserved for future use. Must be IID_NULL.
- Names: The array of names to be mapped.
- NameCount: The count of the names to be mapped.
- LocaleID: The locale context in which to interpret the names.
- DispIDs: Caller-allocated array, each element of which contains an identifier (ID) corresponding to one of the names passed in the rgszNames array.
GetTypeInfo protected stdcall (declared in THYFakeIDispatch)
Retrieves the type information for an object, which can then be used to get the type information for an interface. Empty.
function GetTypeInfo(Index: Integer; LocaleID: Integer; out TypeInfo: ): HResult
Parameters:
- Index: Index of the type information to return.
- LocaleID: The locale identifier for the type information.
- TypeInfo: The requested type information object.
GetTypeInfoCount protected stdcall (declared in THYFakeIDispatch)
Retrieves the number of type information interfaces that an object provides (either 0 or 1). Empty
function GetTypeInfoCount(out Count: Integer): HResult
Parameters:
- Count: The number of type information interfaces provided by the object. If the object provides type information, this number is 1; otherwise the number is 0.
InterfaceSupportsErrorInfo protected stdcall (declared in THYFakeIDispatch)
Indicates whether an interface supports the IErrorInfo interface.
function InterfaceSupportsErrorInfo(const iid: TIID): HResult
Parameters:
- iid: An interface identifier (IID).
Invoke protected stdcall (declared in THYFakeIDispatch)
Provides access to properties and methods exposed by an object. Empty.
function Invoke(DispID: Integer; const IID: TGUID; LocaleID: Integer; Flags: Word; var Params: ; VarResult: Pointer; ExcepInfo: Pointer; ArgErr: Pointer): HResult
Parameters:
- DispID: Identifies the member.
- IID: Reserved for future use. Must be IID_NULL.
- LocaleID: The locale context in which to interpret arguments.
- Flags: Flags describing the context of the Invoke call.
- Params: Pointer to a DISPPARAMS structure containing an array of arguments, an array of argument DISPIDs for named arguments, and counts for the number of elements in the arrays.
- VarResult: Pointer to the location where the result is to be stored, or nil if the caller expects no result.
- ExcepInfo: Pointer to a structure that contains exception information.
- ArgErr: The index within rgvarg of the first argument that has an error.
SafeCallException override (declared in THYFakeIDispatch)
Handles exceptions in methods declared using the safecall calling convention.
function SafeCallException(ExceptObject: TObject; ExceptAddr: Pointer): HResult
Parameters:
- ExceptObject: Exception object.
- ExceptAddr: Addres of the exception.
CreatorFunc
property CreatorFunc: THYCrossPlatformPluginCreatorFunc read write
delegate: procedure CreatorFunc(out anInstance: IInterface)