[<<Previous Entry]
[^^Up^^]
[Next Entry>>]
[Menu]
[About The Guide]
GetPvProfileInt( cSection, cEntry, nDefault, cIniFile ) -> <nValue>
/* API: GetPrivatProfileInt() */
------------------------------------------------------------------------------
PARAMETER:
<cSection> Specifies the section containing the entry.
<cEntry> The entry whose value is to be retrieved.
<nDefault> Specifies the default numeric value to return if the entry
cannot be found.
<cIniFile> Is the Filename of the Initialisation file that contains
the value to retrieve. If this parameter does not contain a
full path, Windows searches for the file in the Windows
directory.
RETURNS:
<nValue> is the numeric value in the given INI file that follows the
specified entry. It is the value of the default parameter if the function
does not find the entry, or zero if the value that corresponds to the
specified entry is not an integer.
DESCRIPTION:
This function retrieves an Integer from the given section in the specified
initialization file. GetPvProfileInt() is not case-dependent, so the
<cSection> and <cEntry> strings may contain a combination of uppercase
and lowercase letters.
An integer entry must have the following form:
[section]
entry=value
.
.
If the value that corresponds to the entry consists of digits followed by
nonnumeric characters, the function returns the value of the digits. For
example, the function would return 102 for the line "Entry=102abc".
An application can use the GetProfileInt function to retrieve an
integer from the WIN.INI file.
EXAMPLE:
+--------------------------------------------------------------+
| /* Retrieve FiveWins default 3D setting */ |
| IF GetPvProfileInt("FiveWin", "ThreeD",; |
| 1, "FiveWin.ini ) == 1 |
| SET 3DLOOK ON |
| ENDIF |
+--------------------------------------------------------------+
SOURCE:
SOURCE\WINAPI\PROFILE.C
See Also:
TINI
GetProfString
GetPvProfString
This page created by ng2html v1.05, the Norton guide to HTML conversion utility.
Written by Dave Pearson