Programming Reference

M_ODPart

Class Definition File	Part.idl
Class C++ Binding	Part.xh
Description	The M_ODPart handler metaclass is provided to part developers. Part developers are required to override the class methods that provide registration information.
Methods	The methods defined by the M_ODPart class include: clsGetOLE2ClassId clsGetODPartHandlerDisplayName clsGetODPartHandlerName clsGetODPartKinds clsGetWindowsIconFileName
Overridden Methods	There are no methods overridden by the M_ODPart class.

clsGetOLE2ClassId

This method returns the OLE2 class ID expressed as a string.

Signature
string clsGetOLE2ClassId ()

Parameters

None.

Returns

rv (string) - returns: The OLE2 class ID expressed as a string. When it is finished using this value, the client code is responsible for freeing the value by calling somFree.

Remarks

This ID will be used to identify this part to OLE containers that want to embed this part. This is required only if interoperability with OLE2 is desired. This method can return a null string.

clsGetODPartHandlerDisplayName

This method returns the part handler's display name.

Signature
string clsGetODPartHandlerDisplayName ()

Parameters

None.

Returns

rv (string) - returns: A string containing the part handler's display name. When it is finished using this value, the client code is responsible for freeing the value by calling somFree.

clsGetODPartHandlerName

This method returns the part handler's name.

Signature
ISOString clsGetODPartHandlerName ()

Parameters

None.

Returns

rv (ISOString) - returns: The part handler name. When it is finished using this value, the client code is responsible for freeing the value by calling somFree.

clsGetODPartKinds

This method returns a sequence containing all of the part kinds supported by this part handler.

Signature
_IDL_SEQUENCE_PartKindInfo clsGetODPartKinds ()

Parameters

None.

Returns

rv (_IDL_SEQUENCE_PartKindInfo) - returns: A sequence containing all the part kinds supported by this part handler. When it is finished using the sequence, the client code is responsible for freeing each of the objects in the sequence and the sequence buffer by calling somFree.

clsGetWindowsIconFileName

This method returns the file name of the icon identifying this part to OLE containers.

Signature
string clsGetWindowsIconFileName ()

Parameters

None.

Returns

rv (string) - returns: The name of a window icon file.

Remarks

This icon will be used to identify this part to OLE containers that want to embed this part. The method can return a null string. This is required only if interoperability with OLE2 is desired. When finished using the value returned by this method, the client code is responsible for freeing the string by calling somFree.