plist

​
Reads & Writes plist data.
Submodules
​cp.plist.archiver​
​cp.plist.plistParser​
API Overview
Functions - API calls offered directly by the extension
​base64ToTable​
​binaryFileToTable​
​binaryFileToXML​
​binaryToTable​
​fileToTable​
​isBinaryPlist​
​xmlFileToTable​
​xmlToTable​
API Documentation
Functions
​base64ToTable​
| Signature | cp.plist.base64ToTable(base64Data) -> table | nil, string | | -----------------------------------------------------|---------------------------------------------------------------------------------------------------------| | Type | Function | | Description | Converts base64 encoded Property List string into a Table. | | Parameters |
base64Data - Binary data encoded in base64 as a string
| | Returns |
A table of the plist data
A error message as string if an error occurs
|
​binaryFileToTable​
| Signature | cp.plist.binaryFileToTable(plistFileName) -> table | nil, string | | -----------------------------------------------------|---------------------------------------------------------------------------------------------------------| | Type | Function | | Description | Converts the data from a Binary File into a LUA Table. | | Parameters |
plistFileName - Path & Filename of the Binary File
| | Returns |
data - A table of plist data, or nil if there was a problem.
err - The error message, or nil if there were no problems.
|
​binaryFileToXML​
| Signature | cp.plist.binaryFileToXML(plistFileName) -> string | nil, string | | -----------------------------------------------------|---------------------------------------------------------------------------------------------------------| | Type | Function | | Description | Converts the data from a Binary plist File into XML as a string. | | Parameters |
plistFileName - Path & Filename of the Binary File
| | Returns |
data - A string of XML data
err - The error message, or nil if there were no problems.
|
​binaryToTable​
| Signature | cp.plist.binaryToTable(binaryData) -> table | nil, string | | -----------------------------------------------------|---------------------------------------------------------------------------------------------------------| | Type | Function | | Description | Converts Binary Data into a LUA Table. | | Parameters |
binaryData - Binary data
| | Returns |
data - A string of XML data
err - The error message, or nil if there were no problems.
|
​fileToTable​
| Signature | cp.plist.fileToTable(plistFileName) -> table | nil, string | | -----------------------------------------------------|---------------------------------------------------------------------------------------------------------| | Type | Function | | Description | Converts plist data from a binary or XML file into a LUA Table. | | Parameters |
plistFileName - Path & Filename of the XML File
| | Returns |
data - A table of plist data, or nil if there was a problem.
err - The error message, or nil if there were no problems.
|
​isBinaryPlist​
Signature
cp.plist.isBinaryPlist(plistList) -> boolean
Type
Function
Description
Returns true if plistList is a binary plist file otherwise false
Parameters
plistList - Path to the file
Returns
Boolean
​xmlFileToTable​
| Signature | cp.plist.xmlFileToTable(plistFileName) -> table | nil, string | | -----------------------------------------------------|---------------------------------------------------------------------------------------------------------| | Type | Function | | Description | Converts XML data from a file into a LUA Table. | | Parameters |
plistFileName - Path & Filename of the XML File
| | Returns |
data - A table of plist data, or nil if there was a problem.
err - The error message, or nil if there were no problems.
|
​xmlToTable​
| Signature | cp.plist.xmlToTable(plistXml) -> table | nil, string | | -----------------------------------------------------|---------------------------------------------------------------------------------------------------------| | Type | Function | | Description | Converts an XML plist string into a LUA Table. | | Parameters |
plistXml - The XML string
| | Returns |
data - A table of plist data, or nil if there was a problem.
err - The error message, or nil if there were no problems.
|