Read Key VI

Owning Palette: Configuration File VIs

Requires: Base Development System

Reads a value associated with a key in a specified section from the configuration data identified by refnum. If the key does not exist, the VI returns the default value. This VI supports multibyte characters in strings. Wire data to the default value input to determine the polymorphic instance to use or manually select the instance.

Example

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

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

Add to the block diagram

Find on the palette

Read Key (Boolean)

	section is the name of the section from which to read the specified key.
	refnum is the reference number of the configuration data.
	key is the name of the key to read.
	default value is the value to return if the VI does not find the key in the specified section or if an error occurs.
	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.
	value is the value of the key.
	error out contains error information. This output provides standard error out functionality.

Read Key (Double)

	section is the name of the section from which to read the specified key.
	refnum is the reference number of the configuration data.
	key is the name of the key to read.
	default value is the value to return if the VI does not find the key in the specified section or if an error occurs.
	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.
	value is the value of the key.
	error out contains error information. This output provides standard error out functionality.

Read Key (I32)

	section is the name of the section from which to read the specified key.
	refnum is the reference number of the configuration data.
	key is the name of the key to read.
	default value is the value to return if the VI does not find the key in the specified section or if an error occurs.
	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.
	value is the value of the key.
	error out contains error information. This output provides standard error out functionality.

Read Key (Path)

	section is the name of the section from which to read the specified key.
	refnum is the reference number of the configuration data.
	key is the name of the key to read.
	default value is the value to return if the VI does not find the key in the specified section or if an error occurs.
	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.
	value is the value of the key.
	error out contains error information. This output provides standard error out functionality.

Read Key (String)

	section is the name of the section from which to read the specified key.
	refnum is the reference number of the configuration data.
	key is the name of the key to read.
	default value is the value to return if the VI does not find the key in the specified section or if an error occurs.
	error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
	read raw string? specifies whether the string was written without escaping unprintable and backslash (\) characters. If FALSE (default), the VI replaces any 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.
	value is the value of the key.
	error out contains error information. This output provides standard error out functionality.

Read Key (U32)

	section is the name of the section from which to read the specified key.
	refnum is the reference number of the configuration data.
	key is the name of the key to read.
	default value is the value to return if the VI does not find the key in the specified section or if an error occurs.
	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.
	value is the value of the key.
	error out contains error information. This output provides standard error out functionality.

Example

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

 Open example  Find related examples