User Tools

Site Tools


en:actions:actionreadinifile

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

en:actions:actionreadinifile [2016/10/09 09:10]
en:actions:actionreadinifile [2020/02/09 13:26] (current)
Line 1: Line 1:
 +====== Read INI file ======
  
 +This action allows reading from an INI file. An INI file is a configuration file often used to save an applications settings.
 +
 +===== Standard parameters =====
 +==== Input parameters ====
 +== File ==
 +The INI file to read.
 +== Mode ==
 +The file reading mode: only one parameter or the whole file. [//Added in Actionaz 3.7.0.//]
 +== Section ==
 +The section where to search for the data.
 +== Parameter ==
 +The parameter name where to search for the data.
 +==== Output parameters ====
 +== Variable ==
 +The name of the variable where to save the read data.
 +===== Exceptions =====
 +
 +  * [[en:​actions:​exceptions#​Bad parameter|Bad parameter]]
 +  * [[en:​actions:​exceptions#​Code error|Code error]]
 +  * [[en:​actions:​exceptions#​timeout|Timeout]]
 +  * [[en:​actions:​actionreadinifile#​unable_to_read_file|Unable to read the file]]
 +  * [[en:​actions:​actionreadinifile#​unable_to_find_section|Unable to find the requested section]]
 +
 +==== Unable to read the file ====
 +<​BOOKMARK:​unable_to_read_file>​
 +
 +This exception is thrown when the file cannot be read.
 +  * Default action: stop the script execution
 +
 +==== Unable to find the requested section ====
 +<​BOOKMARK:​unable_to_find_section>​
 +
 +This exception is thrown when the requested section cannot be found.
 +  * Default action: stop the script execution