Pointwise Plugin SDK
Classes | Variables
+ Collaboration diagram for PWP-API/SDK Data Types and Instances:

Classes

struct  PWU_RTITEM
 The runtime data representing a PWP-API suported by a plugin. More...
 

Variables

PWP_UINT32 publishedApiCnt
 The total # of published entries in pwpRtItem[]. More...
 
PWU_RTITEM pwpRtItem []
 The runtime array of PWU_RTITEM items. More...
 
PWP_UINT32 totalApiCnt
 The total # of published and unpublished entries in pwpRtItem[]. More...
 

Detailed Description

The SDK data types and instances that implement the PWP-API.

Variable Documentation

◆ publishedApiCnt

PWP_UINT32 publishedApiCnt

The total # of published entries in pwpRtItem[].

See also
PwpEnumAPIs()

Definition at line 45 of file apiPWP.cxx.

Referenced by PwpEnumAPIs(), PwpGetAPICount(), and PwuFindPublishedAPI().

◆ pwpRtItem

PWU_RTITEM pwpRtItem[]

The runtime array of PWU_RTITEM items.

This array is initialized in apiPWP.cxx by including the plugin-defined data from the .../YourPlugin/rtPwpVersions.h and .../YourPlugin/rtPwpInitItems.h header files.

There will be one entry in this array for each published API supported by the plugin and one entry for each "special" unpublished APIs used internally by the SDK. The unpublished APIs are always last in the array.

The published items in this array are used to generate return values for PwpEnumAPIs().

Note
A typical CAE plugin will define 2 items:
  • The base PWP-API, "Plugin-PWP/1.0"
  • The CAEP-API, "Export-CAE/1.0"
See also
PwpEnumAPIs(), PWP_MESSAGECB_DEFAULT, PWP_MESSAGECB_SPY

Definition at line 26 of file apiPWP.cxx.

Referenced by PwpEnumAPIs(), and PwuFindAPI().

◆ totalApiCnt

PWP_UINT32 totalApiCnt

The total # of published and unpublished entries in pwpRtItem[].

See also
PwpEnumAPIs(), PWP_MESSAGECB_DEFAULT, PWP_MESSAGECB_SPY

Definition at line 44 of file apiPWP.cxx.

Referenced by PwuFindTotalAPI().