PvGetSelectionString()
Retrieves display string for a specific choice of selection type setting.
Header File: config.h (See also
Header Files
)
Function First Available In Library: w3dbav75.dll (Windows), libpsqldti.so (Linux), libpsqldti.dylib (OS X) (See also
Link Libraries
)
Syntax
BTI_SINT PvGetSelectionString(
BTI_LONG
hConnection,
BTI_ULONG
settingID,
BTI_ULONG
selection,
BTI_ULONG_PTR
pBufSize,
BTI_CHAR_PTR
dispString
);
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
selection
Selection choice index. PSelectionList returned from
PvGetAllPossibleSelections()
.
In/Out
pBufSize
Address of an unsigned long containing size of the buffer allocated to receive the string. It receives the actual length of selection string.
Out
dispString
Display string returned.
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 selection type.
P_E_BUFFER_TOO_SMALL
The array size is too small. In this case, the required size is returned in
pBufSize.
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.
See Also
PvStart()
PvConnectServer()
PvGetCategoryList()
PvGetSettingList()
PvGetSelectionStringSize()
PvDisconnect()
PvStop()