System Global Function CATGetEnvValue
CATGetEnvValue( | const | iVarName, |
| | oVarValue) |
-
Retrieves the value of an environment variable.
Role:Retrieves the value of an environment variable
The memory is allocated by the function CATGetEnvValue. The caller must then
free the allocated memory by calling the standard libc function free
- Parameters:
-
- iVarName
- The Name of the requested environment variable
- oVarValue
- The address where the returned pointer to the string is located.
This argument could be null, if the caller just wants to know if
the variable is set but is not interested in its value
- Returns:
- Legal values
- CATLibSuccess
- the query succeeds.
- CATLibError
- the variable doesn't exist.
This object is included in the file: CATGetEnvValue.h
Copyright © 1999-2015, Dassault Systèmes. All rights reserved.