INIWrite (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Windows management functions

Miscellaneous WINDEV functions

INIWrite

Presentation

Example

Writing into a INI file in Unicode mode

Miscellaneous

Windows Vista (and later)

See also

INIWrite (Function)

In french: INIEcrit

Writes a specific value into an INI file (or into a file structured like an .INI file). You can:

write the value of a keyword found in a specific section,
create or delete a keyword,
create or delete a section.

Versions 15 and later

This function is now available for Android applications.

New in version 15

This function is now available for Android applications.

Versions 17 and later

This function is now available for iPhone/iPad applications.

New in version 17

This function is now available for iPhone/iPad 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

// Store the selected product in the .INI
INIWrite("USER", "LastProd", ...
NumToString(ListSelect(LIST_Product)), ...
fCurrentDir() + "\Port.INI")

Example of .INI file:

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

// Write into the [WD examples] section
INIWrite("WD examples", "Name3", "WDExample", "C:\Temp\ExamplesLST.INI")

Syntax

<Result> = INIWrite(<Section> [, <Keyword> [, <Value> [, <File>]]])

<Result>: Boolean

True if the operation was performed,
False otherwise.

<Section>: Character string

Name of section where the write operation will be performed. The section is automatically created if it does not exist.
Remark: This name cannot contain the "-" character.

<Keyword>: Optional character string

Name of keyword containing the information to write. This keyword s automatically created if it does not exist.
The section will be deleted if this parameter is an empty string ("") or if it corresponds to NULL.
Versions 17 and later
This parameter must necessarily be specified.
New in version 17
This parameter must necessarily be specified.
This parameter must necessarily be specified.

<Value>: Optional character string

Text to write for the keyword and the specified section. The keyword will be deleted if this parameter is an empty string ("") or if ti corresponds to NULL.
Remark: This name cannot contain the TAB character.
This name cannot contain the quotation mark character.
Versions 17 and later
This parameter must necessarily be specified.
New in version 17
This parameter must necessarily be specified.
This parameter must necessarily be specified.

<File>: Optional character string

Full name of file to complete (with its extension).
The WIN.INI file will be used if this parameter is not specified.
If only the path is not specified, the file will be sought in the Windows directory.
The directory will not be created if it does not exist.
The file will be created if it does not exist in the specified directory.
Full name of file to complete (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.
Versions 15 and later
Full name of file to complete (with its extension). This parameter can correspond to a full path or a path relative to the current directory (returned by fCurrentDir). This parameter is case sensitive.
If this parameter is not specified, the file used will be the one named like the project and found in the application runtime directory (current directory). The file will be created if it does not exist.
If only the path is not specified , the file will be sought in the application runtime directory (current directory).
Reminder: In Android, the file system is read-only on the device and on the emulator. An application can only write to its setup directory or one of its subdirectories, as well as to the external memory (SDCard).
New in version 15
Full name of file to complete (with its extension). This parameter can correspond to a full path or a path relative to the current directory (returned by fCurrentDir). This parameter is case sensitive.
If this parameter is not specified, the file used will be the one named like the project and found in the application runtime directory (current directory). The file will be created if it does not exist.
If only the path is not specified , the file will be sought in the application runtime directory (current directory).
Reminder: In Android, the file system is read-only on the device and on the emulator. An application can only write to its setup directory or one of its subdirectories, as well as to the external memory (SDCard).
Full name of file to complete (with its extension). This parameter can correspond to a full path or a path relative to the current directory (returned by fCurrentDir). This parameter is case sensitive.
If this parameter is not specified, the file used will be the one named like the project and found in the application runtime directory (current directory). The file will be created if it does not exist.
If only the path is not specified , the file will be sought in the application runtime directory (current directory).
Reminder: In Android, the file system is read-only on the device and on the emulator. An application can only write to its setup directory or one of its subdirectories, as well as to the external memory (SDCard).
Versions 16 and later
This parameter is mandatory. This parameter can correspond to a full path or to a relative path in relation to the current directory. The current directory corresponds to the data directory of application.
Reminder: Only the files found in the data directory associated with the application can be handled.
New in version 16
This parameter is mandatory. This parameter can correspond to a full path or to a relative path in relation to the current directory. The current directory corresponds to the data directory of application.
Reminder: Only the files found in the data directory associated with the application can be handled.
This parameter is mandatory. This parameter can correspond to a full path or to a relative path in relation to the current directory. The current directory corresponds to the data directory of application.
Reminder: Only the files found in the data directory associated with the application can be handled.
Full name of file to fill (with its extension).
The PHP.INI file will be used if this parameter is not specified.
If only the path is not specified , the file will be sought in the current directory. The file will be created if it does not exist.
Versions 17 and later
This parameter is mandatory. This parameter can correspond to a full path or a path relative to the current directory (returned by fCurrentDir). This parameter is case-sensitive.
Reminder: On iPhone/iPad, an application has the rights to write into its setup directory or into one of its subdirectories.
New in version 17
This parameter is mandatory. This parameter can correspond to a full path or a path relative to the current directory (returned by fCurrentDir). This parameter is case-sensitive.
Reminder: On iPhone/iPad, an application has the rights to write into its setup directory or into one of its subdirectories.
This parameter is mandatory. This parameter can correspond to a full path or a path relative to the current directory (returned by fCurrentDir). This parameter is case-sensitive.
Reminder: On iPhone/iPad, an application has the rights to write into its setup directory or into one of its subdirectories.

Remarks

Versions 17 and later

Writing into a INI file in Unicode mode

Your application operates in Unicode mode ("Use UNICODE strings at runtime" checked in the "Unicode" tab of configuration description).

In this case, to write into an INI file, this INI file must be in Unicode format, which means that it must have a Unicode BOM header.

Example:

fCreate(gsINIFile, foUnicode) // creates gsINIFile with BOM UNICODE
INIWrite("French", "Country", "French",gsINIFile)
INIWrite("中国","国家", "中国", gsINIFile)

New in version 17

Writing into a INI file in Unicode mode

Your application operates in Unicode mode ("Use UNICODE strings at runtime" checked in the "Unicode" tab of configuration description).

In this case, to write into an INI file, this INI file must be in Unicode format, which means that it must have a Unicode BOM header.

Example:

fCreate(gsINIFile, foUnicode) // creates gsINIFile with BOM UNICODE
INIWrite("French", "Country", "French",gsINIFile)
INIWrite("中国","国家", "中国", gsINIFile)

Writing into a INI file in Unicode mode

Your application operates in Unicode mode ("Use UNICODE strings at runtime" checked in the "Unicode" tab of configuration description).

In this case, to write into an INI file, this INI file must be in Unicode format, which means that it must have a Unicode BOM header.

Example:

fCreate(gsINIFile, foUnicode) // creates gsINIFile with BOM UNICODE
INIWrite("French", "Country", "French",gsINIFile)
INIWrite("中国","国家", "中国", gsINIFile)

Miscellaneous

We do not advise you to write into the WIN.INI file.
To write into the registry, use the functions specific to the registry: RegistrySetValue, etc.
The INI files are limited to 64 KB (in Windows 98).

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 to the Windows directory or to the "Program Files" directory,
use the system directory of the application (returned by SysDir with the srAppDataCommun constant, for example).

Component: wd270std.dll