Pointwise Plugin SDK
|
Data and functions useful to PWP-API compliant plugins. More...
Go to the source code of this file.
Classes | |
struct | PWU_RTITEM |
The runtime data representing a PWP-API suported by a plugin. More... | |
struct | PWU_UNFDATA |
Unformatted file data block. More... | |
Macros | |
#define | PWU_ENDIAN_BIG PWP_ENDIAN_BIG |
These PWU_ENDIAN macros are defined for backward compatibility. Usage is deprecated. Use the PWP_ENDIAN types instead. More... | |
#define | PWU_ENDIAN_ERROR PWP_ENDIAN_ERROR |
These PWU_ENDIAN macros are defined for backward compatibility. Usage is deprecated. Use the PWP_ENDIAN types instead. More... | |
#define | PWU_ENDIAN_FOREIGN PWP_ENDIAN_FOREIGN |
These PWU_ENDIAN macros are defined for backward compatibility. Usage is deprecated. Use the PWP_ENDIAN types instead. More... | |
#define | PWU_ENDIAN_LITTLE PWP_ENDIAN_LITTLE |
These PWU_ENDIAN macros are defined for backward compatibility. Usage is deprecated. Use the PWP_ENDIAN types instead. More... | |
#define | PWU_ENDIAN_NATIVE PWP_ENDIAN_NATIVE |
These PWU_ENDIAN macros are defined for backward compatibility. Usage is deprecated. Use the PWP_ENDIAN types instead. More... | |
#define | PWU_ENDIANNESS PWP_ENDIANNESS |
These PWU_ENDIAN macros are defined for backward compatibility. Usage is deprecated. Use the PWP_ENDIAN types instead. More... | |
Functions | |
const void * | PwuApplyEndianness (PWP_ENDIANNESS endianness, const void *buf, size_t size) |
Apply specified byte order to buf containing size bytes. More... | |
PWP_MESSAGECB | PwuFindApiMsgCB (const char api[]) |
Search pwpRtItem[] for an API's messageCB. More... | |
PWU_RTITEM * | PwuFindPublishedAPI (const char api[]) |
Find a published api in pwpRtItem[]. More... | |
PWU_RTITEM * | PwuFindTotalAPI (const char api[]) |
Find any api in pwpRtItem[]. More... | |
PWP_ENDIANNESS | PwuGetOsEndianness (void) |
Query the OS's native endianness. More... | |
PWP_BOOL | PwuGetValue (const char group[], const char name[], PWP_HVALUE value) |
Implementation of the PwpGetValue() API function. More... | |
PWP_BOOL | PwuProgressBegin (const char api[], PWP_UINT32 totalSteps) |
Send a progress begin message (PWP_MSGID_PROGBEGIN) to the framework. More... | |
void | PwuProgressEnd (const char api[], PWP_BOOL ok) |
Send a progress end message (PWP_MSGID_PROGEND) to the framework. More... | |
PWP_BOOL | PwuProgressNextStep (const char api[]) |
Send a progress "next step" message (PWP_MSGID_PROGSTATUS, value = -1) to the framework. More... | |
PWP_BOOL | PwuProgressQuit (const char api[]) |
Send a progress query-quit message (PWP_MSGID_PROGQUIT) to the framework. More... | |
PWP_BOOL | PwuProgressStatus (const char api[], PWP_UINT32 complete, PWP_UINT32 total) |
Send a progress status message (PWP_MSGID_PROGSTATUS, value >= 0) to the framework. More... | |
PWP_BOOL | PwuPublishValueDefinition (const char group[], const char name[], PWP_ENUM_VALTYPE type, const char value[], const char access[], const char desc[], const char range[]) |
Create a value. More... | |
void | PwuSendDebugMsg (const char api[], const char txt[], PWP_UINT32 code) |
Send a debug text message (PWP_MSGID_DEBUG) to the framework. More... | |
void | PwuSendErrorMsg (const char api[], const char txt[], PWP_UINT32 code) |
Send an error text message (PWP_MSGID_ERROR) to the framework. More... | |
void | PwuSendInfoMsg (const char api[], const char txt[], PWP_UINT32 code) |
Send an info text message (PWP_MSGID_INFO) to the framework. More... | |
PWP_UINT32 | PwuSendMsg (const char api[], PWP_ENUM_MSGID id, void *pMsg) |
Send a message from an api. More... | |
void | PwuSendWarningMsg (const char api[], const char txt[], PWP_UINT32 code) |
Send a warning text message (PWP_MSGID_WARNING) to the framework. More... | |
PWP_BOOL | PwuUnfFileBegin (FILE *fp, PWU_UNFDATA *pUData) |
Prepares a PWU_UNFDATA block for a new unformatted file I/O session. More... | |
PWP_BOOL | PwuUnfFileEnd (PWU_UNFDATA *pUData) |
Finalize an unformatted file I/O session. More... | |
PWP_ENDIANNESS | PwuUnfFileGetEndianness (PWU_UNFDATA *pUData) |
Get the output endianness setting for this PWU_UNFDATA block. More... | |
PWP_ENDIANNESS | PwuUnfFileSetEndianness (PWU_UNFDATA *pUData, PWP_ENDIANNESS endianness) |
Set the output endianness. More... | |
PWP_BOOL | PwuUnfHadError (PWU_UNFDATA *pUData) |
Check if an unformatted file I/O session has detected any errors. More... | |
PWP_BOOL | PwuUnfRecBegin (PWU_UNFDATA *pUData) |
Prepares a PWU_UNFDATA block for writing a new unformatted data record. More... | |
PWP_BOOL | PwuUnfRecBeginFixed (PWU_UNFDATA *pUData, PWP_UINT32 bytes, PWP_UINT32 count) |
Prepares a PWU_UNFDATA block for writing a new unformatted data record when the amount of data being written is known ahead of time. More... | |
PWP_UINT32 | PwuUnfRecBytes (PWU_UNFDATA *pUData) |
Get the running total number of bytes written to the current record during an unformatted file I/O session. More... | |
PWP_UINT32 | PwuUnfRecCount (PWU_UNFDATA *pUData) |
Get the running total number of finalized records written during an unformatted file I/O session. More... | |
PWP_BOOL | PwuUnfRecEnd (PWU_UNFDATA *pUData) |
Finalize the current record write. More... | |
PWP_BOOL | PwuUnfRecWriteArr (PWU_UNFDATA *pUData, const void *arr, size_t itemSize, size_t itemCnt) |
Write an array of data to the current record. More... | |
PWP_BOOL | PwuUnfRecWriteBuf (PWU_UNFDATA *pUData, const void *buf, size_t size) |
Write a data buffer to the current record. More... | |
PWP_BOOL | PwuUnfRecWriteEndianBuf (PWU_UNFDATA *pUData, const void *buf, size_t size) |
Write a data buffer to the current record with endian order applied. More... | |
PWP_BOOL | PwuUnfRecWriteFLOAT (PWU_UNFDATA *pUData, PWP_FLOAT val) |
Write a PWP_FLOAT value to the current record with endian order applied. More... | |
PWP_BOOL | PwuUnfRecWriteINT (PWU_UNFDATA *pUData, PWP_INT val) |
Write a PWP_INT value to the current record with endian order applied. More... | |
PWP_BOOL | PwuUnfRecWriteINT16 (PWU_UNFDATA *pUData, PWP_INT16 val) |
Write a PWP_INT16 value to the current record with endian order applied. More... | |
PWP_BOOL | PwuUnfRecWriteINT32 (PWU_UNFDATA *pUData, PWP_INT32 val) |
Write a PWP_INT32 value to the current record with endian order applied. More... | |
PWP_BOOL | PwuUnfRecWriteINT64 (PWU_UNFDATA *pUData, PWP_INT64 val) |
Write a PWP_INT64 value to the current record with endian order applied. More... | |
PWP_BOOL | PwuUnfRecWriteINT8 (PWU_UNFDATA *pUData, PWP_INT8 val) |
Write a PWP_INT8 value to the current record with endian order applied. More... | |
PWP_BOOL | PwuUnfRecWriteREAL (PWU_UNFDATA *pUData, PWP_REAL val) |
Write a PWP_REAL value to the current record with endian order applied. More... | |
PWP_BOOL | PwuUnfRecWriteUINT (PWU_UNFDATA *pUData, PWP_UINT val) |
Write a PWP_UINT value to the current record with endian order applied. More... | |
PWP_BOOL | PwuUnfRecWriteUINT16 (PWU_UNFDATA *pUData, PWP_UINT16 val) |
Write a PWP_UINT16 value to the current record with endian order applied. More... | |
PWP_BOOL | PwuUnfRecWriteUINT32 (PWU_UNFDATA *pUData, PWP_UINT32 val) |
Write a PWP_UINT32 value to the current record with endian order applied. More... | |
PWP_BOOL | PwuUnfRecWriteUINT64 (PWU_UNFDATA *pUData, PWP_UINT64 val) |
Write a PWP_UINT64 value to the current record with endian order applied. More... | |
PWP_BOOL | PwuUnfRecWriteUINT8 (PWU_UNFDATA *pUData, PWP_UINT8 val) |
Write a PWP_UINT8 value to the current record with endian order applied. More... | |
PWP_UINT32 | PwuUnfTotRecBytes (PWU_UNFDATA *pUData) |
Get the running total number of bytes written to all records during an unformatted file I/O session. More... | |
PWP_BOOL | PwuValueSetEnum (PWP_HVALUE value, const char *val) |
Set the value of a variable handle. More... | |
PWP_BOOL | PwuValueSetInt (PWP_HVALUE value, PWP_INT val) |
Set the value of a variable handle. More... | |
PWP_BOOL | PwuValueSetReal (PWP_HVALUE value, PWP_REAL val) |
Set the value of a variable handle. More... | |
PWP_BOOL | PwuValueSetString (PWP_HVALUE value, const char *val) |
Set the value of a variable handle. More... | |
PWP_BOOL | PwuValueSetUInt (PWP_HVALUE value, PWP_UINT val) |
Set the value of a variable handle. More... | |
PWP_BOOL | PwuAssignValue (const char group[], const char name[], const char value[], bool createIfNotExists=false) |
Assign or create a value. More... | |
PWP_BOOL | PwuAssignValueEnum (const char group[], const char name[], const char value[], bool createIfNotExists=false) |
Assign or create a value. More... | |
PWP_BOOL | PwuAssignValueInt (const char group[], const char name[], PWP_INT value, bool createIfNotExists=false) |
Assign or create a value. More... | |
PWP_BOOL | PwuAssignValueReal (const char group[], const char name[], PWP_REAL value, bool createIfNotExists=false) |
Assign or create a value. More... | |
PWP_BOOL | PwuAssignValueUInt (const char group[], const char name[], PWP_UINT value, bool createIfNotExists=false) |
Assign or create a value. 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... | |
Data and functions useful to PWP-API compliant plugins.
Definition in file apiPWPUtils.h.