This library contains the code to interface with the the Livecode Dictionary.
# Where
Contents/Tools/Toolset/libraries revidedocumentationlibrary.livecodescript
# Contains
- ideDocsFetchLCSData - ideDocsFetchLCSDataOfType - ideDocsFetchLCSElementOfType - ideDocsFetchLibraryNames - ideDocsFetchLCSEntries
/* Fetch the data for LiveCode builder dictionary entries with name <pEntryName> Returns: A numerically keyed array, each element of which is the array of data pertaining to a LiveCode builder dictionary entry with the given name. */ function ideDocsFetchLCBData pEntryName return ideDocsFetchData(pEntryName, "LiveCode Builder") end ideDocsFetchLCBData
/* Fetch the data for the LiveCode builder dictionary entry with name <pEntryName> and type <pType> Returns: An array of data pertaining to the unique LiveCode builder dictionary entry with the given name and type. */ function ideDocsFetchLCBDataOfType pEntryName, pType return ideDocsFetchDataOfType(pEntryName, "LiveCode Builder", pType) end ideDocsFetchLCBDataOfType
/* Fetch a specific element of the array of data for the LiveCode builder dictionary entry with name <pEntryName> and type <pType>. Returns: Either a string or an array of data describing the element of the array of data pertaining to the LiveCode builder dictionary entry with the given name and type. */ function ideDocsFetchLCBElementOfType pEntryName, pType, pElement return ideDocsFetchElementOfType(pEntryName, "LiveCode Builder", pType, pElement) end ideDocsFetchLCBElementOfType
/* Fetch the data for entries in the API for extension <pID> with name <pEntryName> Returns: A numerically keyed array, each element of which is the array of data pertaining to an entry in the API for the given extension with the given name. */ function ideDocsFetchExtensionData pID, pEntryName local tLibraryName put revIDEExtensionProperty(pID, "title") into tLibraryName return ideDocsFetchData(pEntryName, tLibraryName) end ideDocsFetchExtensionData
/* Fetch the data for the entry in the API for extension <pID> with name <pEntryName> and type <pType> Returns: An array of data pertaining to the unique entry in the API for the given extension with the given name and type. */ function ideDocsFetchExtensionDataOfType pID, pEntryName, pType local tLibraryName put revIDEExtensionProperty(pID, "title") into tLibraryName return ideDocsFetchDataOfType(pEntryName, tLibraryName, pType) end ideDocsFetchExtensionDataOfType
/* Fetch a specific element of the array of data for the entry in the API for extension <pID> with name <pEntryName> and type <pType>. Returns: Either a string or an array of data describing the element of the array of data pertaining to the entry in the API for the given extension with the given name and type. */ function ideDocsFetchExtensionElementOfType pID, pEntryName, pType, pElement local tLibraryName put revIDEExtensionProperty(pID, "title") into tLibraryName return ideDocsFetchElementOfType(pEntryName, tLibraryName, pType, pElement) end ideDocsFetchExtensionElementOfType
/* Fetch the data for all entries in the LiveCode builder dictionary Returns: A numerically keyed array, each element of which is the array of data pertaining to an entry in the LiveCode builder dictionary. */ function ideDocsFetchLCBEntries return ideDocsFetchLibraryEntries("LiveCode Builder") end ideDocsFetchLCBEntries
/* Fetch the data for all entries in the API for extension <pID> Returns: A numerically keyed array, each element of which is the array of data pertaining to an entry in the API for the given extension. */ function ideDocsFetchExtensionEntries pID local tLibraryName put revIDEExtensionProperty(pID, "title") into tLibraryName return ideDocsFetchLibraryEntries(tLibraryName) end ideDocsFetchExtensionEntries
on ideDocsUpdateDatabase pLibraryA ideDocsInitialize local tResult revExecuteSQL sConnection,"BEGIN TRANSACTION" dispatch "revDocsUpdateDatabase" to stack "revDocsParser" with sConnection, pLibraryA put the result into tResult if tResult is not empty then revExecuteSQL sConnection,"ROLLBACK" return tResult end if revExecuteSQL sConnection, "COMMIT" return empty end ideDocsUpdateDatabase