WriteProFileString
This reference collection includes Vector documentation reproduced with permission. Snippets may require configuration-specific symbols and are not all standalone programs. Sources and validation limits.
Note Before this function can be called the writepathmust be set by the functionsetWritePath. Otherwise the configuration directory will be used. A relative file name must be passed to the function.
Syntax
long writeProfileString(char section[], char entry[], char value[], char filename[]); form 1
long writeProfileString(char section[], char entry[], char value[], char filename[], dword utf16); // form 2
Function
Opens the filefilename, searches thesectionsection and writes the variableentrywith thevaluevalue. Ifentryalready exists the oldvalueis overwritten. The functional result is the number of characters written or 0 in case of an error.
Parameters
section Section of the file as a string.
entry
Variable name as a string.
value
Value as a string.
filename
File path as a string.
utf16
If this flag is set the file will be UTF-16LE encoded if it is newly written, or interpreted as such, if the corresponding BOM is also present.
Return Values
0: Write error
1: Write access. Number of characters will not be returned.
Example