Job Management Partner 1/Software Distribution Automatic Installation Tool Description and Reference

[Contents][Glossary][Index][Back][Next]

AIT_GetProfileString

Description

Acquires the value of a specified key from a section in a specified INI file.

Format

bool AIT_GetProfileString  (
  string strIniFileName,     // INI filename
  string strSectionName,     // Section name
  string strKeyName,         // Key name
  string strValue            // Key value
);

Parameters

strIniFileName (input)

Specify an INI filename.

strSectionName (input)

Specify a section name in an INI file.

strKeyName (input)

Specify a key name belonging to a section name.

strValue (output)

Specify a variable to receive a key value. When the function returns, the variable stores the key value.

Return values

The return value is true if the function was executed normally, and false if not. If the function has returned false, you can use AIT_GetLastError to acquire an extended error code. The following gives the error codes that AIT_GetLastError may return.

Extended error number Error code
2 ERROR_FILE_NOT_FOUND
3 ERROR_PATH_NOT_FOUND
5 ERROR_ACCESS_DENIED
6 ERROR_INVALID_HANDLE
8 ERROR_NOT_ENOUGH_MEMORY
14 ERROR_OUTOFMEMORY
15 ERROR_INVALID_DRIVE
21 ERROR_NOT_READY
38 ERROR_HANDLE_EOF
53 ERROR_BAD_NETPATH
87 ERROR_INVALID_PARAMETER
112 ERROR_DISK_FULL
123 ERROR_INVALID_NAME
148 ERROR_PATH_BUSY
161 ERROR_BAD_PATHNAME
998 ERROR_NOACCESS
1005 ERROR_UNRECOGNIZED_VOLUME
1169 ERROR_NO_MATCH
1210 ERROR_INVALID_COMPUTERNAME
1214 ERROR_INVALID_NETNAME
1231 ERROR_NETWORK_UNREACHABLE