Class CImplementationInformation

class CImplementationInformation : public CBase;

Description

CImplementationInformation

This class acts as the container for the registration data relating to a particular Interface Implementation. Note that this class is used in both the ECOM client and server side, For the client side only the API used to extract the registration data should be used.

It is available to the client to allow access to the registered characteristics of the implementation. These characteristics are:

ImplementationUid() The Uid of this implementation.

Version() The version number of this implementation.

DisplayName() The human readable name for this implementation returned as a 16 bit descriptor.

DataType() The data type which this implementation supports, returned as an 8 bit descriptor.

OpaqueData() The opaque data which is registered for this implementation, returned as an 8 bit descriptor.

RomOnly() The flag indicating whether this implementation is to be loaded from ROM only.

RomBased() The flag recording whether this implementation is on ROM or is a later version of one on ROM.

VendorId() The Vendor ID of the plug-in which this implementation belongs to

Derivation

• CBase - Base class for all classes to be instantiated on the heap

• CImplementationInformation - CImplementationInformation

Members

Defined in CImplementationInformation:
DataType(), Disabled(), DisplayName(), Drive(), ImplementationUid(), OpaqueData(), RomBased(), RomOnly(), SetDisabled(), VendorId(), Version()

Inherited from CBase:
Delete(), Extension_(), operator new()

inline const TDesC &DisplayName() const;

Pre-Condition

CImplementationInformation is fully constructed and initialized

Description

Intended Usage : Accessor for this implementation's human readable name

Return value

const TDesC & The human readable name for this implementation

inline const TDesC8 &DataType() const;

Pre-Condition

CImplementationInformation is fully constructed and initialized

Description

Intended Usage : Accessor for this implementation's default binary data

Return value

const TDesC8 & The data type which this implementation supports

inline const TDesC8 &OpaqueData() const;

Pre-Condition

CImplementationInformation is fully constructed and initialized

Description

Intended Usage : Accessor for this implementation's opaque binary data

Return value

const TDesC8 & The opaque data which is available for this implementation

inline TUid ImplementationUid() const;

Pre-Condition

CImplementationInformation is fully constructed and initialized

Description

Intended Usage : Accessor for this implementation's Uid

Return value

TUid The Uid of this implementation

inline TInt Version() const;

Pre-Condition

CImplementationInformation is fully constructed and initialized

Description

Intended Usage : Accessor for the version number of this implementation

Return value

TInt The version number of this implementation

inline TBool Disabled() const;

Pre-Condition

CImplementationInformation is fully constructed and initialized

Description

Intended Usage : Accessor for whether this implementation is currently disabled

Return value

TBool Flag indicating whether this implementation is disabled

inline void SetDisabled(TBool aDisabled);

Pre-Condition

CImplementationInformation is fully constructed and initialized

Description

Intended Usage : Marks this implementation as disabled, or enabled. Note that this function should not be used by any ECOM client side as it will have no effect at all on the implementation information stored in the server side.

Post-Condition

Implementation is marked as.

Parameters

TBool aDisabled ETrue to indicate this implementation should be disabled, EFalse for enabled.

inline TDriveUnit Drive() const;

Pre-Condition

CImplementationInformation is fully constructed.

Description

Intended Usage : Returns the drive that this implementation is installed on Error Condition : None

Return value

TDriveUnit The drive that this implementation is on

inline TBool RomOnly() const;

Pre-Condition

CImplementationInformation is fully constructed

Description

Intended Usage : Accessor for whether this implementation is to be loaded from ROM only

Return value

TBool Flag indicating whether this implementation is to be loaded from ROM only

inline TBool RomBased() const;

Pre-Condition

CImplementationInformation is fully constructed

Description

Intended Usage : Accessor for whether this implementation is on ROM or is a later version of one on ROM

Return value

TBool Flag indicating whether this implementation is on ROM or is a later version of one on ROM

inline TVendorId VendorId() const;

Pre-Condition

CImplementationInformation is fully constructed

Description

Intended Usage: Returns the VID of the plug-in that this implementation belongs to. The VID is the VendorId for the plug-in's DLL

Return value

TVendorId VendorId of the plug-in that this implementation belongs to.