PvGetStringValueSize()
Retrieves the value (Null terminated string) for a string type setting, from the data source specified by
whichData
. Some settings may return a list of strings separated by semicolons (;).
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 PvGetStringValueSize(
BTI_LONG
hConnection,
BTI_ULONG
settingID,
BTI_ULONG_PTR
pBufSize,
BTI_SINT
whichData
);
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 the size of the buffer allocated to receive the setting value. Receives the actual size of setting value.
In
whichData
Flag to indicate which value is requested:
PVDATA_DEFAULT returns default value.
PVDATA_CURRENT returns current value
Return Values
P_OK
The operation was successful.
P_E_INVALID_HANDLE
Invalid connection handle.
P_E_NULL_PTR
Call with NULL pointer.
P_E_INVALID_DATA_TYPE
The requested setting is not of string type.
P_E_FAIL
Failed for other reasons.
Remarks
The following preconditions 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()
PvGetStringType()
PvSetStringValue()
PvDisconnect()
PvStop()