Write Key VI

Owning Palette: Configuration File VIs

Requires: Base Development System

Writes a value to a key in a specified section of the configuration data identified by refnum. This VI modifies data in memory. To write data to disk, use the Close Config Data VI. Wire data to the value input to determine the polymorphic instance to use or manually select the instance.

Format the content of an .ini file correctly when you use this VI.

Details  Example

Use the pull-down menu to select an instance of this VI.

Select an instance Write Key (Boolean)Write Key (Double)Write Key (I32)Write Key (Path)Write Key (String)Write Key (U32)

Add to the block diagram

Find on the palette

Write Key (Boolean)

	section is the name of the section in which to write the specified key.
	refnum is the reference number of the configuration data.
	key is the name of the key to write.
	value is the value to write to the key.
	error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
	refnum out is the reference number of the configuration data.
	found? is TRUE if the VI found the key in the specified section.
	error out contains error information. This output provides standard error out functionality.

Write Key (Double)

	use system decimal point specifies whether to use the localized decimal separator. The default is TRUE.
	section is the name of the section in which to write the specified key.
	refnum is the reference number of the configuration data.
	key is the name of the key to write.
	value is the value of the key to write.
	error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
	precision is the number of digits after the decimal point. The default is 6.
	format is the format of the number. 0 Fractional (default) 1 Engineering 2 Exponential
	refnum out is the reference number of the configuration data.
	found? is TRUE if the VI found the key in the specified section.
	error out contains error information. This output provides standard error out functionality.

Write Key (I32)

	section is the name of the section in which to write the specified key.
	refnum is the reference number of the configuration data.
	key is the name of the key to write.
	value is the value of the key to write.
	error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
	refnum out is the reference number of the configuration data.
	found? is TRUE if the VI found the key in the specified section.
	error out contains error information. This output provides standard error out functionality.

Write Key (Path)

	section is the name of the section in which to write the specified key.
	refnum is the reference number of the configuration data.
	key is the name of the key to write.
	value is the value of the key to write.
	error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
	refnum out is the reference number of the configuration data.
	found? is TRUE if the VI found the key in the specified section.
	error out contains error information. This output provides standard error out functionality.

Write Key (String)

	section is the name of the section in which to write the specified key.
	refnum is the reference number of the configuration data.
	key is the name of the key to write.
	value is the value of the key to write.
	error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
	write raw string? specifies whether to write the string without escaping unprintable and backslash (\) characters. If FALSE (default), the VI converts any backslashes (\) to double backslashes (\\) and replaces any remaining unprintable characters in the string, such as <ESC>, with a backslash and two Hex characters (\xx). If TRUE, the VI does not convert the unprintable characters in the string.
	refnum out is the reference number of the configuration data.
	found? is TRUE if the VI found the key in the specified section.
	error out contains error information. This output provides standard error out functionality.

Write Key (U32)

	section is the name of the section in which to write the specified key.
	refnum is the reference number of the configuration data.
	key is the name of the key to write.
	value is the value of the key to write.
	error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
	refnum out is the reference number of the configuration data.
	found? is TRUE if the VI found the key in the specified section.
	error out contains error information. This output provides standard error out functionality.

Write Key Details

If key exists, the VI replaces the existing value. If key does not exist, the VI adds the key/value pair to the end of the specified section. If section does not exist, the VI adds section, with the key/value pair, to the end of the configuration data.

Example

Refer to the Configuration (INI) File.lvproj in the labview\examples\File IO\Configuration (INI) directory for an example of using the Write Key VI.

 Open example  Find related examples