revXMLRPC_CreateRequest

Typefunction
DictionaryLCS
LibraryLiveCode Script
Syntax
revXMLRPC_CreateRequest([<RPChost>],[<RPCport>],[<filePath>],[<connProtocol>])
Associationsxml-rpc library
Summary

Creates an XML-RPC request structure, optionally setting its host, port, path and protocol.

Introduced2.5
OSmac, windows, linux, ios, android
Platformsdesktop, server, mobile
Parameters
NameTypeDescription
RPChost

The IP address or domain name of the host you want to connect to.

RPCport

The port number you want to connect to. If you don't specify a port, port 80 is used. (On most systems, port 80 is used for HTTP connections.)

filePath

Usually a file path, which allows the host to determine which resource handles your request.

connProtocol

The protocol determines the type of connection that is established with the host. By default, XML-RPC uses HTTP connections, but for added security you can use HTTPS connections, if the host supports it.

Example
get revXMLRPC_CreateRequest(field "Host",field "Port",field "Path",field "Protocol")
put revXMLRPC_CreateRequest("example.com",80,"RPC2","http") into theRequest
Values
NameTypeDescription
return

The revXMLRPC_CreateRequest function returns a document ID which can be used to refer to the request in other XML-RPC library commands and functions. The request ID is always a positive integer. If the function encounters an error while parsing the data, it returns an error message beginning with "xmlrpcerr".

RelatedKeyword: integer, http
Command: revXMLRPC_SetProtocol, revXMLRPC_SetPath, revXMLRPC_SetPort, revXMLRPC_SetSocket, revXMLRPC_DeleteAllDocuments
Function: revXMLRPC_GetHost
Glossary: LiveCode custom library, return, XML-RPC, Standalone Application Settings, XML-RPC document, standalone application, function, command, HTTP
Library: XML-RPC library
Securitydisk, process
Description

Use the revXMLRPC_CreateRequest function to create an XML-RPC document that you can use with other XML-RPC library commands and functions. XML-RPC is a remote procedure call (RPC) protocol which uses XML to encode its calls via a HTTP transport mechanism.

If the RPChost is empty, the revXMLRPC_CreateRequest function defaults the request host to be the computer running the application, also known as "localhost"

If the RPCport is empty, the revXMLRPC_CreateRequest function defaults the request port to 80, which is the default port for HTTP connections.

If the filePath is empty, the revXMLRPC_CreateRequest function defaults the request path to "RPC2", which is the standard path for XML-RPC server resources.

If the connProtocol is empty, the revXMLRPC_CreateRequest function defaults the request protocol to HTTP connections.

If the revXMLRPC_CreateRequest function encounters an error, it returns an error message starting with "xmlrpcerr". Such an error can also be captured and recalled using the revXMLRPC_Error function.

Important: The revXMLRPC_CreateRequest function is part of the XML-RPC library. To ensure that the function works in a standalone application, you must include this custom library when you create your standalone. In the Inclusions pane of the Standalone Application Settings window, make sure the "XML-RPC" library checkbox is checked.

Tagsnetworking