PvGetStringType()
Retrieves additional information about PVSETTING_STRING setting which only applies to string 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 PvGetStringType(
BTI_LONG
hConnection,
BTI_ULONG
settingID,
BTI_ULONG_PTR
pTypeString
);
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
pTypeString
Subtype of PVSETTING_STRING returned.
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 string 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.
Here are possible subtypes of PVSETTING_STRING:
•
PVSTRING //a string that is neither dir or file
•
PVFILESTRING //string indicates path to a file
•
PVDIRECTORYSTRING //string indicates a directory
The subtypes are defined in config.h.
See Also
PvStart()
PvConnectServer()
PvGetCategoryList()
PvGetSettingList()
PvGetStringValue()
PvSetStringValue()
PvDisconnect()
PvStop()