Function name: GetPrivateProfileSection

Defined in : Kernel32

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

Declaration:

Declare Function GetPrivateProfileSection Lib "kernel32" Alias "GetPrivateProfileSectionA" (ByVal lpAppName As String, ByVal lpReturnedString As String, ByVal nSize 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. * lpReturnedString [out] Pointer to a buffer that receives the key name and value pairs associated with the named section. The buffer is filled with one or more null-terminated strings; the last string is followed by a second null character. * nSize [in] Specifies the size, in TCHARs, of the buffer pointed to by the lpReturnedString parameter. Windows 95/98/Me: The maximum buffer size is 32,767 characters. * 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:

The return value specifies the number of characters copied to the buffer, not including the terminating null character. If the buffer is not large enough to contain all the key name and value pairs associated with the named section, the return value is equal to nSize minus two.

Related functions:

Examples:

INI Related Functions