THYVCLServicePluginDescriptor
Overview
THYVCLServicePluginDescriptor is the class that holds description of a Remoting SDK service plugin.
Location
- Unit: Hydra.RO.VCL.ServicePluginDescriptor.pas
- Ancestry: TPersistent | THYBaseDescriptor | THYPluginDescriptor | THYCrossPlatformPluginDescriptor | THYUnmanagedPluginDescriptor | THYServicePluginDescriptor | THYVCLServicePluginDescriptor
constructor Create overload (declared in THYBaseDescriptor)
Creates a new instance of the class.
constructor Create
constructor Create (TClass, string, Integer, Integer, string, string, string, THYCrossPlatformModule, THYCrossPlatformPluginCreatorFunc) (declared in THYUnmanagedPluginDescriptor)
constructor Create(aPluginClass: TClass; const aName: string; aMajorVersion: Integer; aMinorVersion: Integer; const aRequiredPrivilege: string; const aDescription: string; const aUserData: string; aModule: THYCrossPlatformModule; aCreatorFunc: THYCrossPlatformPluginCreatorFunc)
Parameters:
- aPluginClass:
- aName:
- aMajorVersion:
- aMinorVersion:
- aRequiredPrivilege:
- aDescription:
- aUserData:
- aModule:
- aCreatorFunc:
constructor Create (IROClassFactory, Integer, Integer, string, string)
constructor Create(aRemObjectsClassFactory: IROClassFactory; aMajorVersion: Integer; aMinorVersion: Integer; const aDescription: string; const aUserData: string)
Parameters:
- aRemObjectsClassFactory:
- aMajorVersion:
- aMinorVersion:
- aDescription:
- aUserData:
constructor Create (string, Integer, Integer, string, string, THYCrossPlatformModule) (declared in THYServicePluginDescriptor)
Creates an instance of the object with specifed parameters.
constructor Create(const aName: string; aMajorVersion: Integer; aMinorVersion: Integer; const aDescription: string; const aUserData: string; aModule: THYCrossPlatformModule)
Parameters:
- aName: Name of the object.
- aMajorVersion: Major version number.
- aMinorVersion: Minor version number.
- aDescription: Description of the object.
- aUserData: User defined data.
- aModule: Module which should be associated with current plugin descriptor.
constructor Create (string, Integer, Integer, string, string, string) (declared in THYPluginDescriptor)
Creates an instance of the object with specifed parameters.
constructor Create(const aName: string; aMajorVersion: Integer; aMinorVersion: Integer; const aRequiredPrivilege: string; const aDescription: string; const aUserData: string)
Parameters:
- aName: Name of the object.
- aMajorVersion: Major version number.
- aMinorVersion: Minor version number.
- aRequiredPrivilege: Plrivileges reuiqred to use this object.
- aDescription: Description of the object.
- aUserData: User defined data.
constructor Create (string, Integer, Integer, string, string, string, THYCrossPlatformModule) (declared in THYCrossPlatformPluginDescriptor)
Creates a new instance of the class.
constructor Create(const aName: string; aMajorVersion: Integer; aMinorVersion: Integer; const aRequiredPrivilege: string; const aDescription: string; const aUserData: string; Module: THYCrossPlatformModule)
Parameters:
- aName: Object name.
- aMajorVersion: Major version of a plugin.
- aMinorVersion: Minor version of a plugin.
- aRequiredPrivilege: Privilege that required to use this plugin.
- aDescription: Description of a plugin.
- aUserData: User defined data.
- Module: Reference to a module that owns this descriptor.
AddRef virtual (declared in THYPluginDescriptor)
Increments the reference count for an interface on an object.
procedure AddRef
Assign override (declared in THYBaseDescriptor)
Copies the properties of a source object.
procedure Assign(Source: TPersistent)
Parameters:
- Source: Source object.
CheckPluginInterface override (declared in THYServicePluginDescriptor)
Checks whether plugin implements specified interface.
function CheckPluginInterface(const anIID: TGUID): Boolean
Parameters:
- anIID: GUID of the inteface.
CheckPluginType override (declared in THYServicePluginDescriptor)
Checks whether plugin is inherited from specified type.
function CheckPluginType(const aType: string): WordBool
Parameters:
- aType: Name of the type.
CreateInstance override (declared in THYServicePluginDescriptor)
Creates plugin instance
function CreateInstance: IInterface
CreatorFunc (declared in THYUnmanagedPluginDescriptor)
property CreatorFunc: THYCrossPlatformPluginCreatorFunc read write
delegate: procedure CreatorFunc(out anInstance: IInterface)
Description (declared in THYBaseDescriptor)
User defined description.
property Description: string read write
InstanceCount (declared in THYPluginDescriptor)
Stores number of active instances.
property InstanceCount: Integer read write
LargeImageIndex (declared in THYPluginDescriptor)
Gets or sets large image index. Deprecated.
property LargeImageIndex: Integer read write
MajorVersion (declared in THYBaseDescriptor)
Gets or sets major version number.
property MajorVersion: Integer read write
MinorVersion (declared in THYBaseDescriptor)
Gets or sets minor version number.
property MinorVersion: Integer read write
Module (declared in THYCrossPlatformPluginDescriptor)
Returns the module which is associated with current plugin descriptor.
property Module: THYCrossPlatformModule read
Name (declared in THYBaseDescriptor)
Gets or sets name of an object.
property Name: string read write
PluginClass (declared in THYUnmanagedPluginDescriptor)
References to the class of the plugin.
property PluginClass: TClass read
PluginType (declared in THYPluginDescriptor)
Stores the type of the plugin.
property PluginType: THYPluginType read
Release virtual (declared in THYPluginDescriptor)
Decrements the reference count for an interface on an object.
procedure Release
RequiredPrivilege (declared in THYBaseDescriptor)
Gets or sets user defined string that holds privilages that is required to use an object.
property RequiredPrivilege: string read write
SetPluginType protected override (declared in THYServicePluginDescriptor)
Allows to override plugin type.
procedure SetPluginType
SmallImageIndex (declared in THYPluginDescriptor)
Gets or sets small image index. Deprecated.
property SmallImageIndex: Integer read write
UserData (declared in THYBaseDescriptor)
Gets or sets string that holds user defined data.
property UserData: string read write
Description (declared in THYBaseDescriptor)
User defined description.
property Description: string read write
InstanceCount (declared in THYPluginDescriptor)
Stores number of active instances.
property InstanceCount: Integer read write
LargeImageIndex (declared in THYPluginDescriptor)
Gets or sets large image index. Deprecated.
property LargeImageIndex: Integer read write
MajorVersion (declared in THYBaseDescriptor)
Gets or sets major version number.
property MajorVersion: Integer read write
MinorVersion (declared in THYBaseDescriptor)
Gets or sets minor version number.
property MinorVersion: Integer read write
Module (declared in THYCrossPlatformPluginDescriptor)
Returns the module which is associated with current plugin descriptor.
property Module: THYCrossPlatformModule read
Name (declared in THYBaseDescriptor)
Gets or sets name of an object.
property Name: string read write
PluginClass (declared in THYUnmanagedPluginDescriptor)
References to the class of the plugin.
property PluginClass: TClass read
PluginType (declared in THYPluginDescriptor)
Stores the type of the plugin.
property PluginType: THYPluginType read
RequiredPrivilege (declared in THYBaseDescriptor)
Gets or sets user defined string that holds privilages that is required to use an object.
property RequiredPrivilege: string read write
SmallImageIndex (declared in THYPluginDescriptor)
Gets or sets small image index. Deprecated.
property SmallImageIndex: Integer read write
UserData (declared in THYBaseDescriptor)
Gets or sets string that holds user defined data.
property UserData: string read write
constructor Create overload (declared in THYBaseDescriptor)
Creates a new instance of the class.
constructor Create
constructor Create (TClass, string, Integer, Integer, string, string, string, THYCrossPlatformModule, THYCrossPlatformPluginCreatorFunc) (declared in THYUnmanagedPluginDescriptor)
constructor Create(aPluginClass: TClass; const aName: string; aMajorVersion: Integer; aMinorVersion: Integer; const aRequiredPrivilege: string; const aDescription: string; const aUserData: string; aModule: THYCrossPlatformModule; aCreatorFunc: THYCrossPlatformPluginCreatorFunc)
Parameters:
- aPluginClass:
- aName:
- aMajorVersion:
- aMinorVersion:
- aRequiredPrivilege:
- aDescription:
- aUserData:
- aModule:
- aCreatorFunc:
constructor Create (IROClassFactory, Integer, Integer, string, string)
constructor Create(aRemObjectsClassFactory: IROClassFactory; aMajorVersion: Integer; aMinorVersion: Integer; const aDescription: string; const aUserData: string)
Parameters:
- aRemObjectsClassFactory:
- aMajorVersion:
- aMinorVersion:
- aDescription:
- aUserData:
constructor Create (string, Integer, Integer, string, string, THYCrossPlatformModule) (declared in THYServicePluginDescriptor)
Creates an instance of the object with specifed parameters.
constructor Create(const aName: string; aMajorVersion: Integer; aMinorVersion: Integer; const aDescription: string; const aUserData: string; aModule: THYCrossPlatformModule)
Parameters:
- aName: Name of the object.
- aMajorVersion: Major version number.
- aMinorVersion: Minor version number.
- aDescription: Description of the object.
- aUserData: User defined data.
- aModule: Module which should be associated with current plugin descriptor.
constructor Create (string, Integer, Integer, string, string, string) (declared in THYPluginDescriptor)
Creates an instance of the object with specifed parameters.
constructor Create(const aName: string; aMajorVersion: Integer; aMinorVersion: Integer; const aRequiredPrivilege: string; const aDescription: string; const aUserData: string)
Parameters:
- aName: Name of the object.
- aMajorVersion: Major version number.
- aMinorVersion: Minor version number.
- aRequiredPrivilege: Plrivileges reuiqred to use this object.
- aDescription: Description of the object.
- aUserData: User defined data.
constructor Create (string, Integer, Integer, string, string, string, THYCrossPlatformModule) (declared in THYCrossPlatformPluginDescriptor)
Creates a new instance of the class.
constructor Create(const aName: string; aMajorVersion: Integer; aMinorVersion: Integer; const aRequiredPrivilege: string; const aDescription: string; const aUserData: string; Module: THYCrossPlatformModule)
Parameters:
- aName: Object name.
- aMajorVersion: Major version of a plugin.
- aMinorVersion: Minor version of a plugin.
- aRequiredPrivilege: Privilege that required to use this plugin.
- aDescription: Description of a plugin.
- aUserData: User defined data.
- Module: Reference to a module that owns this descriptor.
AddRef virtual (declared in THYPluginDescriptor)
Increments the reference count for an interface on an object.
procedure AddRef
Assign override (declared in THYBaseDescriptor)
Copies the properties of a source object.
procedure Assign(Source: TPersistent)
Parameters:
- Source: Source object.
CheckPluginInterface override (declared in THYServicePluginDescriptor)
Checks whether plugin implements specified interface.
function CheckPluginInterface(const anIID: TGUID): Boolean
Parameters:
- anIID: GUID of the inteface.
CheckPluginType override (declared in THYServicePluginDescriptor)
Checks whether plugin is inherited from specified type.
function CheckPluginType(const aType: string): WordBool
Parameters:
- aType: Name of the type.
CreateInstance override (declared in THYServicePluginDescriptor)
Creates plugin instance
function CreateInstance: IInterface
Release virtual (declared in THYPluginDescriptor)
Decrements the reference count for an interface on an object.
procedure Release
SetPluginType protected override (declared in THYServicePluginDescriptor)
Allows to override plugin type.
procedure SetPluginType
CreatorFunc (declared in THYUnmanagedPluginDescriptor)
property CreatorFunc: THYCrossPlatformPluginCreatorFunc read write
delegate: procedure CreatorFunc(out anInstance: IInterface)