docs » cp.plist


Reads & Writes plist data.

Submodules

API Overview

API Documentation

Functions

base64ToTable

Signature `cp.plist.base64ToTable(base64Data) -> table nil` </span>
Type Function
Description Converts base64 Data into a LUA Table.
Parameters
  • base64Data - Binary data encoded in base64
Returns
  • A table of the plist data

binaryFileToTable

Signature `cp.plist.binaryFileToTable(plistFileName) -> table nil` </span>
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` </span>
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` </span>
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` </span>
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` </span>
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.

results matching ""

    No results matching ""