Welcome
INIPlus
1.2.2.0
A human-readable file format using some combined features of INI and XML.
Free to use and distribute.
Centauri Soldier
www.AMSPublic.com
CentauriSoldier@AMSPublic.com
© 2009 www.AMSPublic.com
Place the "INIPlus" folder in your "AutoPlay Media Studio\Plugins\Actions" folder
INIPlus.CreateSection
INIPlus.CreateFromINI
INIPlus.ChangeSectionName
INIPlus.CopySection
INIPlus.CountSections
INIPlus.CountValues
INIPlus.DeleteSection
INIPlus.DeleteValue
INIPlus.ExportToINI
INIPlus.GetSectionAttribute
INIPlus.GetSectionNames
INIPlus.GetValue
INIPlus.GetValueAttribute
INIPlus.GetValueNames
INIPlus.ReadToTable
INIPlus.SectionDoesExist
INIPlus.SetSectionAttribute
INIPlus.SetValueAttribute
INIPlus.SetValueData
INIPlus.SetValueAttributeAndData
INIPlus.ShowErrors
INIPlus.ValueDoesExist
INIPlus.CreateSection ( | (string) File = "AutoPlay\\Docs\\NewFile.ipf", (string) Section = "Preferences", (string) Attribute = "User Preferences" ) |
(OPTIONAL) Although sections are created automatically when a value's attribute or data is specified, sometimes it is desirable to create blank sections. This function does just that.
Note: The INIPlus format IS case sensitive. The escape character (for manually editing an INIPlus file) is a carrot "^". Comments can placed anywhere outside of sections but must still escape with a carrot "^" when using function symbols ([, ], <, >, |, =, ", ')
(string) The INIPlus file to access.
(string) The name of the section to create.
(string) The section's attribute. This can be left blank.
This action dose not return any value.
INIPlus.CreateFromINI ( | (string) INIPlus File = "AutoPlay\\Docs\\NewFile.ipf", (string) INI File = "AutoPlay\\Docs\\OldFile.ipf" ) |
Creates an INIPlus file from an INI file.
Note: The INIPlus format IS case sensitive. The escape character (for manually editing an INIPlus file) is a carrot "^". Comments can placed anywhere outside of sections but must still escape with a carrot "^" when using function symbols ([, ], <, >, |, =, ", ')
(string) The INIPlus file to create.
(string) The INI file to be copied.
This action dose not return any value.
INIPlus.ChangeSectionName ( | (string) File = "AutoPlay\\Docs\\MyFile.ipf", (string) Old Name = "Old Section", (string) New Name = "New Section" ) |
Changes the name of an existing section.
Note: The INIPlus format IS case sensitive. The escape character (for manually editing an INIPlus file) is a carrot "^". Comments can placed anywhere outside of sections but must still escape with a carrot "^" when using function symbols ([, ], <, >, |, =, ", ')
(string) The INIPlus file to access.
(string) The name of the existing section.
(string) The name to which the section will be changed.
This action dose not return any value.
INIPlus.CopySection ( | (string) File = "AutoPlay\\Docs\\MyFile.ipf", (string) Old Section = "Old Section", (string) Copied Section = "Copy Cat" ) |
Copies an existing section with all attributes, values and value attributes to a new section.
Note: The INIPlus format IS case sensitive. The escape character (for manually editing an INIPlus file) is a carrot "^". Comments can placed anywhere outside of sections but must still escape with a carrot "^" when using function symbols ([, ], <, >, |, =, ", ')
(string) The INIPlus file to access.
(string) The name of the existing section.
(string) The name to call the newly-copied section.
This action dose not return any value.
(number) INIPlus.CountSections ( | (string) File = "AutoPlay\\Docs\\MyFile.ipf" ) |
Counts the number of sections and returns the number.
Note: The INIPlus format IS case sensitive. The escape character (for manually editing an INIPlus file) is a carrot "^". Comments can placed anywhere outside of sections but must still escape with a carrot "^" when using function symbols ([, ], <, >, |, =, ", ')
(string) The INIPlus file to access.
(number) Returns the number of sections in a INIPlus file. If an error occurs then -1 is returned.
(number) INIPlus.CountValues ( | (string) File = "AutoPlay\\Docs\\MyFile.ipf", (string) Section = "My Section" ) |
Counts the number of values in a given section and returns the number.
Note: The INIPlus format IS case sensitive. The escape character (for manually editing an INIPlus file) is a carrot "^". Comments can placed anywhere outside of sections but must still escape with a carrot "^" when using function symbols ([, ], <, >, |, =, ", ')
(string) The INIPlus file to access.
(string) The section in which to count the values.
(number) Returns the number of values in a given section in an INIPlus file. If an error occurs then -1 is returned.
INIPlus.DeleteSection ( | (string) File = "AutoPlay\\Docs\\MyFile.ipf", (string) Section = "My Section" ) |
Deletes an existing section and all its values.
Note: The INIPlus format IS case sensitive. The escape character (for manually editing an INIPlus file) is a carrot "^". Comments can placed anywhere outside of sections but must still escape with a carrot "^" when using function symbols ([, ], <, >, |, =, ", ')
(string) The INIPlus file to access.
(string) The name of the section to delete.
This action dose not return any value.
INIPlus.DeleteValue ( | (string) File = "AutoPlay\\Docs\\MyFile.ipf", (string) Section = "My Section", (string) Value = "My Value" ) |
Deletes a value in a specifc section.
Note: The INIPlus format IS case sensitive. The escape character (for manually editing an INIPlus file) is a carrot "^". Comments can placed anywhere outside of sections but must still escape with a carrot "^" when using function symbols ([, ], <, >, |, =, ", ')
(string) The INIPlus file to access.
(string) The section which contains the target value.
(string) The value to delete.
This action dose not return any value.
INIPlus.ExportToINI ( | (string) INIPlus File = "AutoPlay\\Docs\\OldFile.ipf", (string) INI File = "AutoPlay\\Docs\\NewFile.ini", (boolean) Include Attributes = true ) |
Exports all data in an INIPlus file and write it to an ini file. All attributes can be included as comments in the new ini file.
Note: The INIPlus format IS case sensitive. The escape character (for manually editing an INIPlus file) is a carrot "^". Comments can placed anywhere outside of sections but must still escape with a carrot "^" when using function symbols ([, ], <, >, |, =, ", ')
(string) The INIPlus file to be copied.
(string) The ini file to create.
(boolean) Whether or not to include the all attributes in the INIPlus file as comments in the new INI file.
This action dose not return any value.
(string) INIPlus.GetSectionAttribute ( | (string) File = "AutoPlay\\Docs\\MyFile.ipf", (string) Section = "My Section" ) |
Retrieves the attribute of the given section.
Note: The INIPlus format IS case sensitive. The escape character (for manually editing an INIPlus file) is a carrot "^". Comments can placed anywhere outside of sections but must still escape with a carrot "^" when using function symbols ([, ], <, >, |, =, ", ')
(string) The INIPlus file to access.
(string) The name of the section whose attribute to get.
(string) A string containing the attribute. If there is no attribute or an error occurs then a blank string ("") is returned.
(table) INIPlus.GetSectionNames ( | (string) File = "AutoPlay\\Docs\\NewFile.ipf" ) |
Gets the names of all sections and returns them in a numerically indexed table.
Note: The INIPlus format IS case sensitive. The escape character (for manually editing an INIPlus file) is a carrot "^". Comments can placed anywhere outside of sections but must still escape with a carrot "^" when using function symbols ([, ], <, >, |, =, ", ')
(string) The INIPlus file to access.
(table) A numerically indexed tables whose values are the sections names.
(string) INIPlus.GetValue ( | (string) File = "AutoPlay\\Docs\\NewFile.ipf", (string) Section = "My Section", (string) Value = "My Value" ) |
Gets the data of a given value.
Note: The INIPlus format IS case sensitive. The escape character (for manually editing an INIPlus file) is a carrot "^". Comments can placed anywhere outside of sections but must still escape with a carrot "^" when using function symbols ([, ], <, >, |, =, ", ')
(string) The INIPlus file to access.
(string) The section which contains the value where the target data is stored.
(string) The value which contains the target data.
(string) A string containing the value's data. If there is no data or an error occurs then a blank string ("") is returned.
(string) INIPlus.GetValueAttribute ( | (string) File = "AutoPlay\\Docs\\NewFile.ipf", (string) Section = "My Value", (string) Value = "My Value" ) |
Gets the attribute of a given value.
Note: The INIPlus format IS case sensitive. The escape character (for manually editing an INIPlus file) is a carrot "^". Comments can placed anywhere outside of sections but must still escape with a carrot "^" when using function symbols ([, ], <, >, |, =, ", ')
(string) The INIPlus file to access.
(string) The section which contains the value where the target attribute is stored.
(string) The value which contains the target attribute.
(string) A string containing the value's attribute. If there is no attribute or an error occurs then a blank string ("") is returned.
(table) INIPlus.GetValueNames ( | (string) File = "AutoPlay\\Docs\\NewFile.ipf", (string) Section = "My Section" ) |
Get all value names from a specified section and returns them in a numerically indexed table.
Note: The INIPlus format IS case sensitive. The escape character (for manually editing an INIPlus file) is a carrot "^". Comments can placed anywhere outside of sections but must still escape with a carrot "^" when using function symbols ([, ], <, >, |, =, ", ')
(string) The INIPlus file to access.
(string) The section in which to count values.
(table) A numerically indexed tables whose values are the value names.
(table) INIPlus.ReadToTable ( | (string) File = "AutoPlay\\Docs\\NewFile.ipf" ) |
Reads the contents of an INIPlus file and returns a table containing two sub tables.
Note: The INIPlus format IS case sensitive. The escape character (for manually editing an INIPlus file) is a carrot "^". Comments can placed anywhere outside of sections but must still escape with a carrot "^" when using function symbols ([, ], <, >, |, =, ", ')
(string) The INIPlus file to access.
(table) Returns a table containing two sub tables. If no data exists or an error occurs then nil is returned.
The first table is indexed by section and value names.
tData["My Section"].ID
tData["My Section"].Name
tData["My Section"].Attribute
tData["My Section"].Values["My Value"].ID
tData["My Section"].Values["My Value"].Name
tData["My Section"].Values["My Value"].Attribute
tData["My Section"].Values["My Value"].Data
The second table is indexed by numbers but contains the same data as the first table.
tData[1].ID
tData[1].Name
tData[1].Attribute
tData[1].Values[1].ID
tData[1].Values[1].Name
tData[1].Values[1].Attribute
tData[1].Values[1].Data
(boolean) INIPlus.SectionDoesExist ( | (string) File = "AutoPlay\\Docs\\NewFile.ipf", (string) Section = "My Section" ) |
Determines whether or not a section exists.
Note: The INIPlus format IS case sensitive. The escape character (for manually editing an INIPlus file) is a carrot "^". Comments can placed anywhere outside of sections but must still escape with a carrot "^" when using function symbols ([, ], <, >, |, =, ", ')
(string) The INIPlus file to access.
(string) The section for which to search.
(boolean) Returns true if a section exists and false if a section does not. If an error occurs then nil is returned.
INIPlus.SetSectionAttribute ( | (string) File = "AutoPlay\\Docs\\NewFile.ipf", (string) Section = "My Section", (string) Attribute = "Some text here" ) |
Set or changes the the attribute of a given section. If the section does not exist it will be created.
Note: The INIPlus format IS case sensitive. The escape character (for manually editing an INIPlus file) is a carrot "^". Comments can placed anywhere outside of sections but must still escape with a carrot "^" when using function symbols ([, ], <, >, |, =, ", ')
(string) The INIPlus file to access.
(string) The section in which to set the attribute.
(string) The attribute text.
This action dose not return any value.
INIPlus.SetValueAttribute ( | (string) File = "AutoPlay\\Docs\\NewFile.ipf", (string) Section = "My Section", (string) Value = "Some text here", (string) Attribute = "Some text here" ) |
Set or changes the attribute of a given value. If the section or value does not exist then it will be created.
Note: The INIPlus format IS case sensitive. The escape character (for manually editing an INIPlus file) is a carrot "^". Comments can placed anywhere outside of sections but must still escape with a carrot "^" when using function symbols ([, ], <, >, |, =, ", ')
(string) The INIPlus file to access.
(string) The section which contains the value for which to set the attribute.
(string) The value for which to set the attribute.
(string) The attribute text.
This action dose not return any value.
INIPlus.SetValueData ( | (string) File = "AutoPlay\\Docs\\NewFile.ipf", (string) Section = "My Value", (string) Value = "My Value", (string) Data = "Some text here" ) |
Set or changes the data of a given value. If the section or value does not exist then it will be created.
Note: The INIPlus format IS case sensitive. The escape character (for manually editing an INIPlus file) is a carrot "^". Comments can placed anywhere outside of sections but must still escape with a carrot "^" when using function symbols ([, ], <, >, |, =, ", ')
(string) The INIPlus file to access.
(string) The section which contains the value for which to set the data.
(string) The value for which to set the data.
(string) the data text. This can be multi-line.
This action dose not return any value.
INIPlus.SetValueAttributeAndData ( | (string) File = "AutoPlay\\Docs\\NewFile.ipf", (string) Section = "My Section", (string) Value = "My Value", (string) Attribute = "Attribute Text", (string) Data = "Data Text" ) |
Set or changes the attribute and data of a given value. If the section or value does not exist then it will be created.
Note: The INIPlus format IS case sensitive. The escape character (for manually editing an INIPlus file) is a carrot "^". Comments can placed anywhere outside of sections but must still escape with a carrot "^" when using function symbols ([, ], <, >, |, =, ", ')
(string) The INIPlus file to access.
(string) The section which contains the value for which to set the attribute and data.
(string) The value for which to set the attribute and data.
(string) The attribute text.
(string) The data text.
This action dose not return any value.
INIPlus.ShowErrors ( | (boolean) Show Errors = false ) |
Set this to true to see any occuring erros with INIPlus actions.
Note: The INIPlus format IS case sensitive. The escape character (for manually editing an INIPlus file) is a carrot "^". Comments can placed anywhere outside of sections but must still escape with a carrot "^" when using function symbols ([, ], <, >, |, =, ", ')
(boolean) Whether or not to show errors created by syntax problems in INIPlus functions. This is good for trouble shooting.
This action dose not return any value.
(boolean) INIPlus.ValueDoesExist ( | (string) File = "AutoPlay\\Docs\\NewFile.ipf", (string) Section = "My Section", (string) Value = "My Value" ) |
Determines whether or not a value exists.
Note: The INIPlus format IS case sensitive. The escape character (for manually editing an INIPlus file) is a carrot "^". Comments can placed anywhere outside of sections but must still escape with a carrot "^" when using function symbols ([, ], <, >, |, =, ", ')
(string) The INIPlus file to access.
(string) The section which contains the target value.
(string) The value for which to search.
(boolean) Returns true if a value exists and false if it does not. If an error occurs then nil is returned.
© 2009 www.AMSPublic.com
This File Was Generated With AMS ActionFile Editor