PvGetBooleanStrings()

Distributed Tuning Interface Reference : PvGetBooleanStrings()

Retrieves display string related to Boolean type setting.

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 PvGetBooleanStrings(

BTI_LONG hConnection,

BTI_ULONG settingID,

BTI_LONG_PTR trueStringSize,

BTI_CHAR_PTR trueString,

BTI_LONG_PTR falseStringSize,

BTI_CHAR_PTR falseString);

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().
Out	trueStringSize	Long integer containing the length of trueString.
Out	trueString	Display string for TRUE (size >= 16 bytes).
Out	falseStringSize	Long integer containing the length of falseString.
Out	falseString	Display string for FALSE (size >= 16 bytes).

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 long type.
P_E_FAIL	Failed for other reasons.

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.