Pointwise Plugin SDK
|
Functions | |
PWP_PROTOTYPE_DECL PWP_BOOL | PwpActivateAPI (const char api[]) |
Activates the plugin for a given API spec. More... | |
PWP_PROTOTYPE_DECL PWP_VOID | PwpDestroy () |
Called by framework just before plugin library is closed. More... | |
PWP_PROTOTYPE_DECL const char * | PwpEnumAPIs (PWP_UINT32 ndx, PWP_APIINFO *pInfo) |
Enumerates the APIs supported by this plugin. More... | |
PWP_PROTOTYPE_DECL PWP_UINT32 | PwpGetAPICount () |
Get the number of APIs supported by this plugin. More... | |
PWP_PROTOTYPE_DECL PWP_MESSAGECB | PwpGetMessageCallback (const char api[]) |
Gets the current message callback. More... | |
PWP_PROTOTYPE_DECL PWP_VERSIONVAL | PwpGetPluginInfo (PWP_PLUGININFO *pInfo) |
Get information about this plugin. More... | |
PWP_PROTOTYPE_DECL PWP_BOOL | PwpGetValue (const char group[], const char key[], PWP_HVALUE value) |
Get the value for a grouped key. More... | |
PWP_PROTOTYPE_DECL PWP_BOOL | PwpInitialize () |
Initializes the plugin. More... | |
PWP_PROTOTYPE_DECL PWP_BOOL | PwpIsLicensed (const char api[], const PWP_LICENSEDATA *pLicenseData) |
Determines if plugin api is licensed for use on this machine. More... | |
PWP_PROTOTYPE_DECL PWP_VOID | PwpSetLanguage (const char language[]) |
Sets the active language. More... | |
PWP_PROTOTYPE_DECL PWP_MESSAGECB | PwpSetMessageCallback (const char api[], PWP_MESSAGECB msgCB) |
Sets the message callback function for the given api. More... | |
PWP_PROTOTYPE_DECL PWP_BOOL PwpActivateAPI | ( | const char | api[] | ) |
Activates the plugin for a given API spec.
An API will be activated by the framework before any API specific calls are made to the plugin.
api | The target api. Must be one of the values returned from PwpEnumAPIs(). |
Definition at line 59 of file apiPWP.cxx.
References PWP_FALSE, PWP_TRUE, and PwuFindPublishedAPI().
PWP_PROTOTYPE_DECL PWP_VOID PwpDestroy | ( | ) |
Called by framework just before plugin library is closed.
Definition at line 65 of file apiPWP.cxx.
PWP_PROTOTYPE_DECL const char* PwpEnumAPIs | ( | PWP_UINT32 | ndx, |
PWP_APIINFO * | pInfo | ||
) |
Enumerates the APIs supported by this plugin.
ndx | The api index starting with 0. |
pInfo | Pointer to the destination PWP_APIINFO buffer. |
Definition at line 70 of file apiPWP.cxx.
References PWU_RTITEM::apiInfo, publishedApiCnt, and pwpRtItem.
PWP_PROTOTYPE_DECL PWP_UINT32 PwpGetAPICount | ( | ) |
Get the number of APIs supported by this plugin.
Definition at line 80 of file apiPWP.cxx.
References publishedApiCnt.
PWP_PROTOTYPE_DECL PWP_MESSAGECB PwpGetMessageCallback | ( | const char | api[] | ) |
Gets the current message callback.
api | The target api. Must be one of the values returned from PwpEnumAPIs(). |
Definition at line 86 of file apiPWP.cxx.
References PwuFindApiMsgCB().
PWP_PROTOTYPE_DECL PWP_VERSIONVAL PwpGetPluginInfo | ( | PWP_PLUGININFO * | pInfo | ) |
Get information about this plugin.
pInfo | Pointer to the PWP_PLUGININFO buffer. |
Definition at line 92 of file apiPWP.cxx.
References PWP_PLUGININFO::apiCount, PWP_PLUGININFO::defCB, publishedApiCnt, PWP_MESSAGECB_DEFAULT, PWP_MESSAGECB_SPY, PwuFindApiMsgCB(), PWP_PLUGININFO::spyCB, and VERSION_PWP_MAJOR.
Referenced by CaePlugin< MT >::getApiVersion(), CaePlugin< MT >::getAuthorInfo(), CaePlugin< MT >::getCopyrightInfo(), CaePlugin< MT >::getInfo(), CaePlugin< MT >::getSupportInfo(), and CaePlugin< MT >::getVersion().
PWP_PROTOTYPE_DECL PWP_BOOL PwpGetValue | ( | const char | group[], |
const char | key[], | ||
PWP_HVALUE | value | ||
) |
Get the value for a grouped key.
The group can be set to NULL or empty for root-level, ungrouped keys.
group | The value's group (see Group Formatting). |
key | The value's name. |
value | A value handle. |
All groups beginning with the key "SDK" are reserved for use by the PluginSDK.
By default, the period '.' is used as the key delimiter. However, if the first character in a group is a period then the group's second character will be used as the group's delimiter.
Definition at line 138 of file apiPWP.cxx.
References PWP_FALSE, PWP_HVALUE_ISVALID, and PwuGetValue().
PWP_PROTOTYPE_DECL PWP_BOOL PwpInitialize | ( | ) |
Initializes the plugin.
Called once and first by the framework immediately after the plugin library is opened.
Definition at line 52 of file apiPWP.cxx.
References PWP_TRUE.
PWP_PROTOTYPE_DECL PWP_BOOL PwpIsLicensed | ( | const char | api[], |
const PWP_LICENSEDATA * | pLicenseData | ||
) |
Determines if plugin api is licensed for use on this machine.
api | The target api. Must be one of the values returned from PwpEnumAPIs(). |
pLicenseData | Pointer to the PWP_LICENSEDATA buffer. |
Definition at line 110 of file apiPWP.cxx.
References PWP_FALSE, PWP_TRUE, and PwuFindPublishedAPI().
Referenced by CaePlugin< MT >::isLicensed().
PWP_PROTOTYPE_DECL PWP_VOID PwpSetLanguage | ( | const char | language[] | ) |
Sets the active language.
If the specified language is not supported, the plugin should default to "us-english".
language | The language identifier. |
Definition at line 130 of file apiPWP.cxx.
Referenced by CaePlugin< MT >::setLanguage().
PWP_PROTOTYPE_DECL PWP_MESSAGECB PwpSetMessageCallback | ( | const char | api[], |
PWP_MESSAGECB | msgCB | ||
) |
Sets the message callback function for the given api.
The plugin uses this callback to send api specific messages to the framework.
api | The target api. Must be one of the values returned from PwpEnumAPIs() or one of the special api targets listed in notes. |
msgCB | Pointer to a function with the signature defined by PWP_MESSAGECB. |
Definition at line 116 of file apiPWP.cxx.
References PWU_RTITEM::msgCB, and PwuFindTotalAPI().