INIRead (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Windows management functions

Miscellaneous WINDEV functions

INIRead

Presentation

Example

Reading the persistent values

Various

Windows Vista (and later)

BuildAutomationVariant

Calling a DLL written in Visual Basic

Constants for managing the WLanguage types

Constants for sound management

Constants used by ExecutePresetAction

Constants used by the TraceStart function

EndAutomatedProcedure

InAndroidEmulatorMode

InAndroidMode

InAndroidSimulatorMode

InAppleWatchEmulatorMode

InAppleWatchMode

InAppleWatchSimulatorMode

InAutomaticTestMode

InBackgroundMode

InComponentMode

InDelayedProcedureMode

InPocketSimulatorMode

InPrelaunchedSessionMode

InReportsAndQueriesMode

InServiceMode

InSimulatorMode

InStoredProcedureMode

InTSEMode

InTestMode

InUMCMode

InUniversalWindowsAppMode

InUniversalWindowsAppSimulatorMode

InUniversalWindowsPlatformMode

InUniversalWindowsPlatformSimulatorMode

InVGAMode

InWebMode

InWebSocketServerGlobalServiceMode

InWebSocketServerMode

InWindowsPhoneEmulatorMode

InWindowsPhoneMode

InWindowsPhoneSimulatorMode

InWindowsStoreAppMode

InWindowsStoreAppSimulatorMode

StyleDrawCaptionGrayed

Voice commands in your applications

Reading the persistent values
Various
Windows Vista (and later)

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

INIRead (Function)

In french: INILit

Reads the content of a INI file (or the content of a file structured like a .INI file). You can get:

the value of a keyword found in a specific section,
the list of keywords found in a section,
the list of file sections.

Versions 16 and later

This function is now available for Windows Phone applications.

New in version 16

This function is now available for Windows Phone applications.

Versions 18 and later

This function is now available in Windows Store apps mode.

New in version 18

This function is now available in Windows Store apps mode.

Versions 21 and later

This function is now available in Universal Windows 10 App mode.

New in version 21

This function is now available in Universal Windows 10 App mode.

Example of .INI file

[WD examples]
Name1 = WDInstall
Name2 = WDBench
[Description of WDInstall]
Caption = Use the control panel of Windows
LST = 43
Page = 12

Example

See additional examples

// Read in the [WD Examples] section
INIRead("WD Examples", "Name2", "", "C:\Temp\ExamplesLST.INI")

// Default choice read in the .INI
nProduct is int = Val(INIRead("USER", ...
"LastProd", "", fExeDir() + "\Port.INI"))
IF nProduct > 0 THEN ListSelectPlus(LIST_Product, nProduct)

Syntax

<Result> = INIRead(<Section> [, <Keyword> [, <Not found> [, <File>]]])

<Result>: Character string

Text sought or list of keywords found in the section (the keywords are separated by CR characters),
List of file sections (the sections are separated by CR characters).
Content of <Not found> in the following cases:
the string corresponding to the keyword is empty,
the keyword is not found,
the file is not found.
Empty string (if <Not found> is not specified or if it is equal to an empty string) in the following cases:
the string corresponding to the keyword is empty,
the keyword is not found,
the file is not found.

<Section>: Character string (with quotes)

Name of section to read in the INI file.
If this parameter and <Keyword> correspond to an empty string, <Result> contains the list of sections found in the file, separated by CR characters.

Remark: This name cannot contain the "-" character.

<Keyword>: Optional character string (with quotes)

Name of the keyword containing the information to read.
If this parameter is an empty string, <Result> contains the list of keywords found in <Section>, separated by CR characters.

<Not found>: Optional character string (with quotes)

Text to return if the requested keyword was not read. This parameter corresponds to an empty string by default.

<File>: Optional character string (with quotes)

Full name of file to read (with its extension).
The WIN.INI file will be used if this parameter is not specified.
If only the name of the file is specified, the specified file will be sought in the directory of Windows.
Full name of file to read (with its extension).
If this parameter is not specified, the file used will be the one named like the project and found in the runtime directory of application.
The file will be created if it does not exist.
If only the path is not specified , the file will be sought in the runtime directory of application.
Full name of file to read (with its extension). The .PCS.conf file will be used if this parameter is not specified (this file must be found in the home directory of the user). If only the path is not specified , the file will be sought in the home directory of the user.

Remarks

Reading the persistent values

To read the persistent values in a INI file (saved with SaveParameter), use LoadParameter.

Various

To read in the registry, use the functions specific to the registry: RegistryQueryValue, ...
The INI files are limited to 64 KB (in Windows 98).
TSE: INIRead is using the Windows directory by default.
Caution: Until version 21, INIRead was using the Windows directory of the user by default.
Reminder: In TSE mode, the access to a '.INI' file with a relative name is not recommended. We advise you to use one of the following solutions:
- SaveParameter and LoadParameter.
- Registry,
- using an absolute name, based on fDataDir for example.

Windows Vista (and later)

The programming standards of Windows do not advise you to write:

into the WIN.INI file,
into the system directories (Windows directory, "Program Files" directory, ...).

In Windows Vista (and later) with the UAC mechanism enabled, the administrator privileges are required to perform these operations. If the application does not have the required administrator privileges, the UAC mechanism will redirect the files (called virtualization) to a directory specific to the user who is using the application (C:\Users\<LOGIN>AppData\Local\VirtualStore\Windows\). The files can be read again by INIRead used in the same application. This virtualization mechanism of files is proposed by Windows Vista (and later) for compatibility and it is not available in 64 bits.

Caution: If the INI file is automatically virtualized by Windows Vista (and later), the INI file cannot be shared between several applications (especially if these applications use different privileges).

Programming tip: To create a INI file without having the administrator privileges:

do not use the WIN.INI file (the <File> parameter must be specified)
avoid writing into the Windows directory or into the "Program Files" directory,
use the system directory corresponding to the application (returned by SysDir with the srCommonAppData constant).

Component: wd260std.dll