PvGetStringValue()

Distributed Tuning Interface Reference : PvGetStringValue()

PvGetStringValue()

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: w3dbav75.dll (Windows), libpsqldti.so (Linux), libpsqldti.dylib (macOS) (See also Link Libraries)

Syntax

BTI_SINT PvGetStringValue(

BTI_LONG hConnection,

BTI_ULONG settingID,

BTI_ULONG_PTR pBufSize,

BTI_CHAR_PTR value,

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.
Out	value	Address of a long integer variable that receives the 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_BUFFER_TOO_SMALL	Allocated buffer is too small for the string (the return string is truncated). In this case, the required size is returned in pBufSize.
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.