XML-RPC library | |
Type | library |
Dictionary | LCS |
Library | LiveCode Script |
Synonyms | xml-rpc library,xml-rpc libraries |
Related | Control Structure: function Glossary: XML-RPC, LiveCode custom library, Standalone Application Settings, standalone application, command Library: XML-RPC library |
Description | The LiveCode custom library that supports creating and executing remote procedure calls according to the XML-RPC protocol and interpreting the results.
|
Tags | networking |
Type | Name | Summary | Syntax |
---|---|---|---|
command | revXMLRPC_AddParam | Adds a single parameter to an XML-RPC document structure. | revXMLRPC_AddParam <XMLRPCdocumentID>, <dataType>, <dataValue> |
- - - | revXMLRPC_DeleteAllDocuments | Removes all XML-RPC document structures in memory. | revXMLRPC_DeleteAllDocuments |
- - - | revXMLRPC_DeleteDocument | Deletes an XML-RPC document structure, freeing up the memory of its associated resources. | revXMLRPC_DeleteDocument <XMLRPCdocumentID> |
- - - | revXMLRPC_DeleteParam | Deletes a single parameter from an XML-RPC document structure. | revXMLRPC_DeleteParam <XMLRPCdocumentID>,<paramNumber> |
- - - | revXMLRPC_GetMethod | Returns the name of the method in an XML-RPC document structure. | revXMLRPC_GetMethod(<XMLRPCdocumentID>) |
- - - | revXMLRPC_SetHost | Sets the host and optionally the port of an XML-RPC document structure. | revXMLRPC_SetHost <XMLRPCdocumentID>, <RPChost> [, <RPCport>] |
- - - | revXMLRPC_SetMethod | Sets the name of the method in an XML-RPC document structure. | revXMLRPC_SetMethod <XMLRPCdocumentID>,<methodName> |
- - - | revXMLRPC_SetPath | Sets the path in an XML-RPC document structure. | revXMLRPC_SetPath <XMLRPCdocumentID>, <filePath> |
- - - | revXMLRPC_SetPort | Sets the port of an XML-RPC document structure. | revXMLRPC_SetPort <XMLRPCdocumentID>, <RPCport> |
- - - | revXMLRPC_SetProtocol | Sets the protocol of an XML-RPC document structure. | revXMLRPC_SetProtocol <XMLRPCdocumentID>, <connProtocol> |
- - - | revXMLRPC_SetSocket | Sets the socket of an XML-RPC document. | revXMLRPC_SetSocket <XMLRPCdocumentID>, <RPCsocket> |
function | revXMLRPC_CreateRequest | Creates an XML-RPC request structure, optionally setting its host, port, path and protocol. | revXMLRPC_CreateRequest([<RPChost>],[<RPCport>],[<filePath>],[<connProtocol>]) |
- - - | revXMLRPC_Documents | Returns a list of all XML-RPC documents in memory. | revXMLRPC_Documents() |
- - - | revXMLRPC_Error | If an error occurred during the execution of an XML-RPC request, this function returns the error. | revXMLRPC_Error(<XMLRPCdocumentID>) |
- - - | revXMLRPC_Execute | Executes an XML-RPC request and returns the result as an XML-RPC document structure. | revXMLRPC_Execute(<XMLRPCdocumentID>) |
- - - | revXMLRPC_GetHost | This function returns the target host of an XML-RPC document. | revXMLRPC_GetHost(<XMLRPCdocumentID>) |
- - - | revXMLRPC_GetParam | Returns a single parameter from an XML-RPC document structure. | revXMLRPC_GetParam(<XMLRPCdocumentID>,<paramNumber>[, <dataType>]) |
- - - | revXMLRPC_GetParamCount | Returns the number of parameters from an XML-RPC document structure. | revXMLRPC_GetParamCount(<XMLRPCdocumentID>) |
- - - | revXMLRPC_GetParamNode | Returns the node of a single parameter from an XML-RPC document structure, so you can parse the data using the XML library commands and functions. | revXMLRPC_GetParamNode(<XMLRPCdocumentID>,<paramNumber>) |
- - - | revXMLRPC_GetParamType | Returns the type of a single parameter from an XML-RPC document structure. | revXMLRPC_GetParamType(<XMLRPCdocumentID>,<paramNumber>) |
- - - | revXMLRPC_GetPath | This function returns the target path of an XML-RPC document. | revXMLRPC_GetPath(<XMLRPCdocumentID>) |
- - - | revXMLRPC_GetPort | This function returns the target port of an XML-RPC document. | revXMLRPC_GetPort(<XMLRPCdocumentID>) |
- - - | revXMLRPC_GetProtocol | This function returns the protocol of an XML-RPC document. | revXMLRPC_GetProtocol(<XMLRPCdocumentID>) |
- - - | revXMLRPC_GetRequest | This function returns the request document that was executed and resulted in the response document. | revXMLRPC_GetRequest(<XMLRPCdocumentID>) |
- - - | revXMLRPC_GetResponse | If the execution of an XML-RPC request was successful, this function returns the response document. | revXMLRPC_GetResponse(<XMLRPCdocumentID>) |
- - - | revXMLRPC_GetSocket | This function returns the socket of an XML-RPC document. | revXMLRPC_GetSocket(<XMLRPCdocumentID>) |