[<<Previous Entry] [^^Up^^] [Next Entry>>] [Menu] [About The Guide]
 GetProfInt( cSection, cEntry, nDefault )-><nValue> /* API: GetProfileInt */
------------------------------------------------------------------------------


 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.


 RETURNS:

  <nValue> is the numeric value in the 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 a value from the WIN.INI file. GetProfileInt() is
  is not case-dependent, so the <cSection> and <cEntry> strings may
  contain a combination of uppercase and lowercase letters. 
  An integer entry in the WIN.INI file 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 GetPvProfileInt function to retrieve an
  integer from a specified INI file. 

 EXAMPLE:


    +--------------------------------------------------------------+
    |  /* Retrieve a Time Out value from WIN.INI */                |
    |  nTime := GetProfIint( "windows", "ScreenSaveTimeOut", 0)    |
    |  MsgBox( "Timeout in " + STR( nTime, 3 ) + " Seconds" )      |
    +--------------------------------------------------------------+


 SOURCE:

  SOURCE\WINAPI\PROFILE.C



See Also: TINI GetProfString GetPvProfileInt GetPvProfString
This page created by ng2html v1.05, the Norton guide to HTML conversion utility. Written by Dave Pearson