<doc>
  <legacy_id>2390</legacy_id>
  <name>revXMLRPC_GetProtocol</name>
  <type>function</type>
  <syntax>
    <example>revXMLRPC_GetProtocol(<i>XML-RPC document</i>)</example>
  </syntax>
  <library>XML-RPC library</library>
  <objects>
  </objects>
  <synonyms>
  </synonyms>
  <classification>
    <category>Text and Data Processing</category>
    <category>Networks &amp; Communication</category>
  </classification>
  <references>
    <command tag="revXMLRPC_SetProtocol">revXMLRPC_SetProtocol Command</command>
  </references>
  <history>
    <introduced version="2.5">Added.</introduced>
  </history>
  <platforms>
    <mac/>
    <windows/>
    <linux/>
  </platforms>
  <classes>
    <desktop/>
    <server/>
    <web/>
  </classes>
  <security>
    <disk access="???"/>
    <process/>
  </security>
  <summary>This function returns the protocol of an XML-RPC document.</summary>
  <examples>
    <example>put revXMLRPC_GetProtocol(theRequest) into theProtocol</example>
  </examples>
  <description>
    <p>Use the <b>revXMLRPC_GetProtocol</b> <glossary tag="function">function</glossary> to retrieve the network protocol used in the execution of an <glossary tag="XML-RPC document">XML-RPC request</glossary>.</p><p/><p><b>Parameters:</b></p><p>The <i>documentID</i> is the number <glossary tag="return">returned</glossary> by the <function tag="revXMLRPC_CreateRequest">revXMLRPC_CreateRequest</function> when you created the <glossary tag="XML-RPC document">XML-RPC request</glossary>, or the successful <function tag="revXMLRPC_Execute">revXMLRPC_Execute</function> <control_st tag="function">function</control_st> when you executed an <glossary tag="XML-RPC document">XML-RPC request</glossary>.</p><p/><p><b>Value:</b></p><p>The <b>revXMLRPC_GetProtocol</b> <control_st tag="function">function</control_st> returns the type of connection that is established with the <glossary tag="host">host</glossary>. By default, XML-RPC uses <keyword tag="http">HTTP</keyword> connections, but for added security you can use <keyword tag="https">HTTPS</keyword> connections, if the host supports it.</p><p/><p><b>Comments:</b></p><p>If the <b>revXMLRPC_GetProtocol</b> <glossary tag="function">function</glossary> encounters an error, it <glossary tag="return">returns</glossary> an error message starting with "xmlrpcerr"..</p><p/><p><img src="202653"/> <b>Important!</b> The <b>revXMLRPC_GetProtocol</b> <glossary tag="function">function</glossary> is part of the <glossary tag="XML-RPC library">XML-RPC library</glossary>. To ensure that the <glossary tag="function">function</glossary> works in a <glossary tag="standalone application">standalone application</glossary>, you must include this <glossary tag="LiveCode custom library">custom library</glossary> when you create your <glossary tag="standalone application">standalone</glossary>. In the Inclusions section on the General screen of the <glossary tag="Standalone Application Settings">Standalone Application Settings</glossary> window, make sure "XML-RPC Library" is selected in the list of script libraries.</p>
  </description>
</doc>