TBApiGetSettingSZ API Call

 

Description

Returns a string value from the general and device sections of the settings file.

Parameters

Device handle (see notes), settings key name, buffer for returned string and length of buffer.

Returns

0 = fail, 1 = OK.

Notes

This will retrieve a string value from the settings file. Supply a valid Device handle to retrieve items for a specific device from the device section or pass zero to retrieve values from the general driver section

See also

Other settings related API calls to set and retrieve updd setting.

 

Visual C++ Declaration/example

 

BOOL TBApiGetSettingSZ(HTBDEVICE aHandle,const TCHAR* aName, TCHAR* aSZ, int lBuff);

 

Visual Basic Declaration/example

 

Public Declare Function TBApiGetSettingSZ Lib "TBapi" Alias "_DLL_TBApiGetSettingSZ@16" (ByVal aHandle As Byte, ByVal aName As String, ByVal aSZ As String, ByVal lBuff As Long) As Long