DTW_GETINIDATA

AIX HP-UX Linux OS/2 OS/390 OS/400 PTX SUN Win NT
X X X X X X X X X

Purpose

Returns the value of the specified configuration variable.

Format

@DTW_GETINIDATA(iniVarName, iniVarValue)

@DTW_rGETINIDATA(iniVarName)

Parameters

Table 39. DTW_GETINIDATA Parameters
Data Type Parameter Use Description
string iniVarName IN A variable or literal string.
string iniVarValue OUT The value of the configuration variable specified in iniVarName.

Return Codes

Table 40. DTW_GETINIDATA Return Codes
Return Code Explanation
-1001 The server could not process a Net.Data request to allocate memory.
1003 An incorrect number of parameters were passed on a function call.
1005 A parameter passed on a function call, required to be a string variable, was of a different variable type.
1006 A literal string was passed on a function call for a parameter which was required to be an output parameter.

Usage Notes

  1. If a configuration variable is specified that is not the configuration file, Net.Data returns an empty string.
  2. For OS/390, OS/2, Windows NT, and UNIX users: configuration path variables (MACRO_PATH, EXEC_PATH, and INCLUDE_PATH), as well as ENVIRONMENT statements, cannot be retrieved with this call.
  3. For OS/400 users: ENVIRONMENT statements cannot be retrieved with this call.

Examples

Example 1: Returns the Net.Data path variable value.

myEnvVarName = "FFI_PATH"
@DTW_GETINIDATA(myEnvVarName, myEnvVarValue)
 

Yields: myEnvVarValue = "D:\FFI"


[ Top of Page | Previous Page | Next Page | Index ]