Al_getenvstring – Measurement Computing ADLIB WIN User Manual
Page 38

Chapter 9 Environment Configurations
9-4
9.4 AL_GetEnvString
Prototype C\C++
ERRNUM
AL_GetEnvString(LPSTR
lpstr, long lMaxLength);
Visual Basic for Windows
Function
AL_GetEnvString(ByVal
lpstr As String,
ByVal lMaxLength As Long) As Long
LPSTR lpstrEnv
destination address
long lMaxLength
the count in bytes to be copied
The AL_GetEnvString function copies lMaxLength bytes for the ADLIB environment string to the
destination string. If the size of the destination string length is less than the string to be copied, the
resulting string will be truncated and NULL padded.
Parameter
Description
lpstrEnv
Points to the input destination string.
lMaxLength
Maximum length in bytes to be copied to the user string , including the NULL
termination
character.
Returns:
On success ERRNUM is set to 1, otherwise ERRNUM contains the last error code that occurred during the
call.
Related Functions:
AL_SetEnvString
Program References:
NONE
Supported Boards:
All