Function name: GetPrivateProfileInt

Defined in : kernel32

Requirements : Windows NT 3.1 or later; Windows 95 or later

Declaration:

Declare Function GetPrivateProfileInt Lib "kernel32" Alias "GetPrivateProfileIntA" (ByVal lpApplicationName As String, ByVal lpKeyName As String, ByVal nDefault As Long, ByVal lpFileName As String) As Long

Parameters:

* lpAppName [in] Pointer to a null-terminated string specifying the name of the section in the initialization file. * lpKeyName [in] Pointer to the null-terminated string specifying the name of the key whose value is to be retrieved. This value is in the form of a string; the GetPrivateProfileInt function converts the string into an integer and returns the integer. * nDefault [in] Specifies the default value to return if the key name cannot be found in the initialization file. * lpFileName [in] Pointer to a null-terminated string that specifies the name of the initialization file. If this parameter does not contain a full path to the file, the system searches for the file in the Windows directory.

Returns:

If the function succeeds, the return value is the integer equivalent of the string following the specified key name in the specified initialization file. If the key is not found, the return value is the specified default value. If the value of the key is less than zero, the return value is zero.

Related functions:

Examples:

INI Related Functions