PvGetSettingUnitsSize()
Returns the size in bytes of buffer size required to receive information in
PvGetSettingUnits()
call.
Header File: config.h (See also
Header Files
)
Function First Available In Library: w3dbav78.dll (Windows), libpsqldti.so (Linux), libpsqldti.dylib (OS X) (See also
Link Libraries
)
Syntax
BTI_SINT PvGetSettingUnitsSize(
BTI_LONG
hConnection,
BTI_ULONG
settingID,
BTI_ULONG_PTR
pBufSize,
BTI_ULONG_PTR
pFBufSize);
Arguments
In
hConnection
Connection handle that identifies the server. Connection handles are obtained with the
PvConnectServer()
function.
In
settingID
Unique identifier for the setting. A list of settings can be obtained from
PvGetSettingList()
.
In/Out
pBufSize
Address of an unsigned long containing size of the buffer allocated to receive string of default units. Receives actual size of string of default units. The size should include the NULL terminator.
In/Out
pFBufSize
Address of an unsigned long containing size of buffer allocated to receive string of “factor” units. Receives actual size of string of default units. The size should include the NULL terminator.
Return Values
P_OK
The operation was successful.
P_E_NULL_PTR
Call with NULL pointer.
P_E_INVALID_DATA_TYPE
The setting requested is not of long integer type.
Remarks
The following precondition must be met:
•
Connection established by
PvConnectServer()
or if you are performing the operation on a local machine, P_LOCAL_DB_CONNECTION may be used as the connection handle.
See Also
PvStart()
PvConnectServer()
PvGetCategoryList()
PvGetSettingList()
PvDisconnect()
PvStop()