Go to the documentation of this file.
9 #ifndef _APIPWPUTILS_H_
10 #define _APIPWPUTILS_H_
299 #define PWU_ENDIANNESS PWP_ENDIANNESS
300 #define PWU_ENDIAN_ERROR PWP_ENDIAN_ERROR
301 #define PWU_ENDIAN_LITTLE PWP_ENDIAN_LITTLE
302 #define PWU_ENDIAN_BIG PWP_ENDIAN_BIG
303 #define PWU_ENDIAN_NATIVE PWP_ENDIAN_NATIVE
304 #define PWU_ENDIAN_FOREIGN PWP_ENDIAN_FOREIGN
443 size_t itemSize,
size_t itemCnt);
704 const char desc[],
const char range[]);
750 const char value[],
bool createIfNotExists =
false);
752 PWP_INT value,
bool createIfNotExists =
false);
754 PWP_UINT value,
bool createIfNotExists =
false);
756 PWP_REAL value,
bool createIfNotExists =
false);
758 const char value[],
bool createIfNotExists =
false);
PWU_RTITEM pwpRtItem[]
The runtime array of PWU_RTITEM items.
PWP_UINT32 totalApiCnt
The total # of published and unpublished entries in pwpRtItem[].
PWU_RTITEM * PwuFindTotalAPI(const char api[])
Find any api in pwpRtItem[].
PWP_BOOL PwuValueSetEnum(PWP_HVALUE value, const char *val)
Set the value of a variable handle.
PWP_BOOL inRec
"in record" flag
void PwuProgressEnd(const char api[], PWP_BOOL ok)
Send a progress end message (PWP_MSGID_PROGEND) to the framework.
PWP_ENUM_VALTYPE
Supported PWP-API getValue() transfer types.
The runtime data representing a PWP-API suported by a plugin.
PWP_BOOL PwuAssignValue(const char group[], const char name[], const char value[], bool createIfNotExists=false)
Assign or create a value.
PWP_BOOL PwuAssignValueInt(const char group[], const char name[], PWP_INT value, bool createIfNotExists=false)
Assign or create a value.
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.
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.
PWP_BOOL PwuProgressNextStep(const char api[])
Send a progress "next step" message (PWP_MSGID_PROGSTATUS, value = -1) to the framework.
PWP_ENDIANNESS PwuGetOsEndianness(void)
Query the OS's native endianness.
PWP_MESSAGECB PwuFindApiMsgCB(const char api[])
Search pwpRtItem[] for an API's messageCB.
PWP_UINT32 publishedApiCnt
The total # of published entries in pwpRtItem[].
void PwuSendWarningMsg(const char api[], const char txt[], PWP_UINT32 code)
Send a warning text message (PWP_MSGID_WARNING) to the framework.
PWP_BOOL PwuValueSetReal(PWP_HVALUE value, PWP_REAL val)
Set the value of a variable handle.
void PwuSendInfoMsg(const char api[], const char txt[], PWP_UINT32 code)
Send an info text message (PWP_MSGID_INFO) to the framework.
PWP_ENDIANNESS endianness
write data using this endianness
PWP_BOOL PwuGetValue(const char group[], const char name[], PWP_HVALUE value)
Implementation of the PwpGetValue() API function.
PWU_RTITEM * PwuFindPublishedAPI(const char api[])
Find a published api in pwpRtItem[].
PWP_UINT32 status
current file status
PWP_UINT32 PwuSendMsg(const char api[], PWP_ENUM_MSGID id, void *pMsg)
Send a message from an api.
void PwuSendErrorMsg(const char api[], const char txt[], PWP_UINT32 code)
Send an error text message (PWP_MSGID_ERROR) to the framework.
PWP_UINT32 fixedBytes
user provided # record bytes
PWP_BOOL PwuAssignValueUInt(const char group[], const char name[], PWP_UINT value, bool createIfNotExists=false)
Assign or create a value.
The API information returned by plugins for each supported API.
PWP_ENUM_MSGID
Supported PWP-API message ids.
PWP_BOOL PwuValueSetString(PWP_HVALUE value, const char *val)
Set the value of a variable handle.
PWP_ENDIANNESS
Flags used to indicate endianness or control endian behaviors in functions.
PWP_MESSAGECB msgCB
The API's assigned message callback.
PWP_UINT32 totRecBytes
total # bytes written to all records
PWP_BOOL PwuProgressQuit(const char api[])
Send a progress query-quit message (PWP_MSGID_PROGQUIT) to the framework.
PWP_APIINFO apiInfo
The PWP-API instance information.
PWP_BOOL PwuAssignValueReal(const char group[], const char name[], PWP_REAL value, bool createIfNotExists=false)
Assign or create a value.
void PwuSendDebugMsg(const char api[], const char txt[], PWP_UINT32 code)
Send a debug text message (PWP_MSGID_DEBUG) to the framework.
PWP_BOOL hadError
error flag
PWP_UINT32(* PWP_MESSAGECB)(const char api[], PWP_ENUM_MSGID id, void *pMsg)
Message handler callback function signature.
const void * PwuApplyEndianness(PWP_ENDIANNESS endianness, const void *buf, size_t size)
Apply specified byte order to buf containing size bytes.
Pointwise Plugin API (PWP-API)
PWP_BOOL PwuAssignValueEnum(const char group[], const char name[], const char value[], bool createIfNotExists=false)
Assign or create a value.
sysFILEPOS fPos
file position value
PWP_BOOL PwuValueSetInt(PWP_HVALUE value, PWP_INT val)
Set the value of a variable handle.
PWP_BOOL PwuProgressBegin(const char api[], PWP_UINT32 totalSteps)
Send a progress begin message (PWP_MSGID_PROGBEGIN) to the framework.
PWP_BOOL PwuValueSetUInt(PWP_HVALUE value, PWP_UINT val)
Set the value of a variable handle.
Unformatted file data block.