Custom Platform Support Development Kit  1.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
DOM::ILibraryItem Class Referenceabstract

Defines the interface that represents a library item in the library. More...

#include <ILibraryItem.h>

Inheritance diagram for DOM::ILibraryItem:

Public Member Functions

virtual FCM::Result _FCMCALL GetName (FCM::StringRep16 *ppName)=0
 Returns the name of the item. More...
 
virtual FCM::Result _FCMCALL GetProperties (PIFCMDictionary &pPropDict)=0
 GetProperties returns a set of property names and their values. More...
 

Detailed Description

Defines the interface that represents a library item in the library.

Member Function Documentation

virtual FCM::Result _FCMCALL DOM::ILibraryItem::GetName ( FCM::StringRep16 ppName)
pure virtual

Returns the name of the item.

Parameters
ppName(OUT) Name of the library item with the full path in Library.
Returns
On success, FCM_SUCCESS is returned, else an error code is returned.
Note
The memory allocated for 'ppName' in this function must be freed by the caller using IFCMCalloc::Free().
virtual FCM::Result _FCMCALL DOM::ILibraryItem::GetProperties ( PIFCMDictionary &  pPropDict)
pure virtual

GetProperties returns a set of property names and their values.

Parameters
pPropDict(OUT) Dictionary containing the properties and their values. The possible properties in the dictionary are as follows: kLibProp_LinkageClass_DictKey, kLibProp_LinkageBaseClass_DictKey, kLibProp_LinkageIdentifier_DictKey, kLibProp_LinkageURL_DictKey, kLibProp_LinkageExportForRS_DictKey, kLibProp_LinkageImportForRS_DictKey, kLibProp_LinkageExportInFirstFrame_DictKey, kLibProp_LinkageExportForAS_DictKey, kLibProp_SymbolType_DictKey
Returns
On success, FCM_SUCCESS is returned, else an error code is returned.

The documentation for this class was generated from the following file: