|
|
Class remx/array
A collection array of objects (object handles).
Objects can be added, removed, set, and retrieved. The Constructor can take a list of objects and/or strings
to initialize the array - for example:
a = new("remx/array") ! Empty Array
a = new("remx/array",obj1,obj2) ! Array inialized with two objects added
a = new("remx/array","string1","string2") ! Array initialized with two remx/string objects
a = new("remx/array",obj1,"str1",obj2,"str2") ! Array initialized with combo of objects and remx/string objects
Properties
PROPERTY Count
Current number of elements in this array
|
PROPERTY Name$
String label for this array.
|
Methods
FUNCTION Add(objectId)
Add an object to the end of the array.
|
FUNCTION Add(sValue$)
Add a string object to the end of the array. This is a convenience method.
A new string object will be created and set to the value passed into the method.
|
FUNCTION Insert(index,objectId)
Insert an object at the specified Index. Count will be incremented.
If Index < 1 or Index>Count or it's not an integer it returns error 42.
|
FUNCTION Insert(index,sValue$)
Insert a string object at the specified Index. This is a convenience method.
Count will be incremented. If Index < 1 or Index>Count or it's not an integer it returns error 42.
|
FUNCTION Set(index,objectId)
Set the objectID at the specified index. If not found it returns -1.
|
FUNCTION Set(index,sValue$)
Set the objectID at the specified index to a new string object. This is a convenience method.
A new string object will be created and set to the value passed into the method.
|
FUNCTION Get(index)
Returns the objectID at the specified index. If not found it returns -1.
|
FUNCTION Get$(index)
Returns the string value of the objectID at the specified index. If not found Exits with ERROR 26 (Invalid Variable Type)
|
FUNCTION FindById(objectId)
Search for the specified ObjectID. If found it returns the Index else it returns -1.
|
FUNCTION Remove(index)
Remove the Object at the specified index. Count will be decremented by one.
|
Class remx/base64
Base64 Data Class.
The Value$ property is the Base64 Encoded data. The Text$ property is the Decoded Value$.
NOTE: Setting either property will automatically encode/decode into the other property.
Properties
|
PROPERTY Value$
|
|
PROPERTY Text$
|
Class remx/boolean
Boolean Data Class.
The Value property can equal 0 (false) or 1 (true). Setting it to any non-zero value will set it to 1.
Value$ can have the value or "true" or "false". It is possible to set it to any of the following strings
and the value will automatically be set to "true" or "false"
0,1,y,n,t,f,yes,no,true,false.
NOTE: Setting either property will automatically set the other property.
Properties
|
PROPERTY Value
|
|
PROPERTY Value$
|
Class remx/datetime
XML-RPC dateTime value object.
In XML-RPC the value in a dataTime element must be of the form 19991231T12:00:00
This is a value object to ease the use of dateTime elements in XML-RPC.
The Value property is the numeric date & time as maintained in PVX by the JUL() function.
The Value$ property is the date & time in the form CCCCMMDDTHH:MM:SS. When Setting Value$, the object
will try to parse the assigned string. If it cannot it will exit with an error 26.
NOTE: Setting either property will automatically set the other.
Properties
|
PROPERTY Value
|
|
PROPERTY Value$
|
Class remx/double
Double Data Class.
Simply a Data Value Object for a double value. The Value$ property is the string value
of the Value property. It cannot be set.
Properties
|
PROPERTY Value
|
|
PROPERTY Value$
|
Class remx/httpconnection
A remx/urlconnection class with support for HTTP-specific features.
This class can only be instantiated with a proper RemoteXerver License.
Properties
|
PROPERTY LastErrorNum$
|
|
PROPERTY LastErrorMsg$
|
PROPERTY RequestMethod$
HTTP Request method such as GET or POST (cannot be set directly)
|
PROPERTY ResponseText$
Response Text returned from the server after a Send() (cannot be set directly)
|
Methods
FUNCTION SetRequestMethod(reqMethod$)
Set the HTTP Request Method such as GET or POST.
|
FUNCTION Send(reqContent$)
Send an HTTP request with the POST request content passed in reqContent$.
|
FUNCTION Send()
Send an HTTP request with no request content.
|
FUNCTION Open(reqMethod$,reqAddress$,reqAsync)
Open an HTTP Connection with request method, address, and Async flag(not supported so any value is ignored)
|
FUNCTION GenerateContent$(Recd$)
Generates a content string for a 'POST' from a list of variables. It will encode the values of all the variables.
Recd$ must be an embedded variable string.
|
FUNCTION GenerateContent$(Recd$,Iolst$)
Generates a content string for a 'POST' from a list of variables. It will encode the values of all the variables.
Recd$ contains the values in a PVX Record format and Iolst$ is the list of variables in PVX IOLIST format.
|
Properties inherited from : remx/urlconnection
LastErrorNum$, LastErrorMsg$, URL$, URL path, Protocol$, TCP Protocol, UserInfo$, User info, Host$, Host name, Document$, Document being, Query$, Query being, Port, Port Number, Connected, Connected flag., TcpChannel, TCP connection, ContentEncoding$, Value of, ContentLength, Value of, ContentType$, Value of, Date$, Value of, Expiration$, Value of, LastModified$, Value of, ResponseCode$, String Value, ResponseCode, Numeric Value, HeaderFields$, List of, RequestProperties$, List of, ChunkedData, TimeOut, User set
Methods inherited from : remx/urlconnection
connect(), disconnect(), setRequestProperty(), getRequestProperty$(), getContent$(), getHeaderField$()
Class remx/integer
Integer Data Class.
Simply an Integer Value Object. The Value$ property is the string value
of the Value property. It cannot be set. Setting Value will only retain the
integer portion of the passed value.
Properties
|
PROPERTY Value
|
|
PROPERTY Value$
|
Class remx/remxbase
Base class for RemoteXerver.
This class can only be instantiated with a proper RemoteXerver License.
Properties
|
PROPERTY LastErrorMsg$
|
|
PROPERTY LastErrorNum$
|
Methods
FUNCTION EncodeUrl$(UrlString$)
Encode a string containing special characters to be usable in an HTTP 'GET'
|
FUNCTION EncodeContent$(ContentString$)
Encode a string containing special characters to be usable in the body of an HTTP 'POST'
|
FUNCTION AsciiToUnicode$(Ascii$)
Convert ASCII string to Unicode
|
FUNCTION UnicodeToAscii$(Unicode$)
Convert Unicode to ASCII
|
FUNCTION GetLocalIPAddress$()
Get the local IP address
|
FUNCTION ParseUrl(URL$,Protocol$,Userinfo$,Host$,Doc$,Query$,Port)
Parse a URL string in the format '<userinfo>@<protocol>://<host>:<port>/<doc>?<query>'
Return the info in the variables Protocol$, Userinfo$, Host$, Doc$, Query$, Port
|
FUNCTION ParseString(sourceString$,result$)
String Parsing function
|
FUNCTION ParseString(sourceString$,result$,separator$)
String Parsing function
|
FUNCTION Element$(string$,element)
Get element number 'element' from a SEP separated string$
|
FUNCTION Element$(string$,element,delim$)
Get element number 'element' from a delim$ separated string$
|
FUNCTION GetElement(string$,value$,delim$)
Get the element number of the value$ in a SEP separated string$
|
FUNCTION GetElement(string$,value$)
Get the element number of the value$ in a delim$ separated string$
|
FUNCTION SetElement(string$,value$,element,delim$)
Set the element number 'element' to value$ in a SEP separated string$
|
FUNCTION SetElement(string$,value$,element)
Set the element number 'element' to value$ in a delim$ separated string$
|
FUNCTION EntityToString$(textString$)
Return a string that decodes special characters from textString$ that is in an XML encoding format
& = &
< = <
> = >
' = '
" = "
� converts to the Hexidecimal value
� converts to the Decimal value
|
FUNCTION StringToEntity$(textString$)
Return a string that is XML encoded from textString$
& = &
< = <
> = >
' = '
" = "
unprintable characters are left untouched.
|
FUNCTION StringToEntity$(textString$,option$)
Return a string that is XML encoded from textString$
If option$ = "X" the special unprintable are encoded as Hexidecimal - �
If option$ = "#" the special unprintable are encoded as Decimal - �
|
FUNCTION GetEscapedText$(text$)
Returns text$ with special characters converted to escape sequences with the field separator = SEP
\\ = The backslash character
\xhh = The character with hexadecimal value 0xhh
\t = The tab character (\h09)
\n = The newline (line feed) character (\h0A)
\r = The carriage-return character (\h0D)
\f = The form-feed character (\h0C)
\a = The alert (bell) character (\h07)
\b = The BackSpace character (\h08)
\e = The escape character (\h1B)
\s = The field separator
|
FUNCTION GetEscapedText$(text$,fieldSep$)
Returns text$ with special characters converted to escape sequences with the field separator = fieldSep$
|
FUNCTION ParseEscapedText$(text$)
Returns the result of Parsing out an escaped text$ with the field separator = SEP
\\ = The backslash character
\xhh = The character with hexadecimal value 0xhh
\t = The tab character (\h09)
\n = The newline (line feed) character (\h0A)
\r = The carriage-return character (\h0D)
\f = The form-feed character (\h0C)
\a = The alert (bell) character (\h07)
\b = The BackSpace character (\h08)
\e = The escape character (\h1B)
\s = The field separator
|
FUNCTION ParseEscapedText$(text$,fieldSep$)
Returns the result of Parsing out an escaped text$ with the field separator = fieldSep$
|
Class remx/saxparser
Simple SAX Parser for XML. It makes use of a Document Handler to handle SAX events.
This class can only be instantiated with a proper RemoteXerver License.
Properties
|
PROPERTY LastErrorNum$
|
|
PROPERTY LastErrorMsg$
|
Methods
FUNCTION SetDocumentHandler(DocumentHandlerObj)
Sets the Document Handler to the object passed in the param DocumentHandlerObj.
|
FUNCTION SetDocumentHandler(DocumentHandlerProg$)
Sets the Document Handler to the program passed in the param DocumentHandlerProg$.
|
FUNCTION ParseXmlString(XmlString$)
Begins parsing of XML Document passed as a string in XmlString$
|
FUNCTION ParseXmlFile(FileName$)
Begins parsing of XML Document in the file FileName$
|
FUNCTION ParseXmlChannel(DocumentFH)
Begins parsing of XML Document in the file open on channel DocumentFH
|
Properties inherited from : remx/remxbase
LastErrorMsg$, LastErrorNum$
Methods inherited from : remx/remxbase
EncodeUrl$(), EncodeContent$(), AsciiToUnicode$(), UnicodeToAscii$(), GetLocalIPAddress$(), ParseUrl(), ParseString(), Element$(), GetElement(), SetElement(), EntityToString$(), StringToEntity$(), GetEscapedText$(), \t = The tab character (), \n = The newline (), \r = The carriage-return character (), \f = The form-feed character (), \a = The alert (), \b = The BackSpace character (), \e = The escape character (), ParseEscapedText$()
Class remx/string
String Data Class.
Simply a Data Value Object for a String.
Class remx/struct
A class to implement a Data Structure Object in PVX.
When instantiated the Structure is empty. Members can be added, set, and retrieved by name.
Members of the Struct can be set to object references.
Properties
PROPERTY Name$
Name of this struct.
|
PROPERTY QName
QName for this Stucture
|
PROPERTY Members$
A comma separated list of the members of this struct.
|
PROPERTY Count
The current Count of the number of members of this struct.
|
Methods
FUNCTION AddMember(memberName$)
Add a new member named memberName$
|
FUNCTION AddMember(memberName$,objectId)
Add a new member named memberName$ to the struct and set it to objectId
|
FUNCTION AddMember(memberName$,sValue$)
Add a new member named memberName$ to the struct and set it to objectId
|
FUNCTION SetMember(memberName$,objectId)
Set an existing member named memberName$ to objectId
|
FUNCTION SetMember(memberName$,sValue$)
Set an existing member named memberName$ to objectId
|
FUNCTION GetMember(memberName$)
Get the value in the member named memberName$
|
FUNCTION GetMember$(memberName$)
Get the value in the member named memberName$
|
Class remx/urlconnection
URL Connection Class.
This class can only be instantiated with a proper RemoteXerver License.
Properties
|
PROPERTY LastErrorNum$
|
|
PROPERTY LastErrorMsg$
|
PROPERTY URL$
URL path to connect (cannot be set directly)
|
PROPERTY Protocol$
TCP Protocol being used such as HTTP (cannot be set directly)
|
PROPERTY UserInfo$
User info encoded in URL (cannot be set directly)
|
PROPERTY Host$
Host name from the URL (cannot be set directly)
|
PROPERTY Document$
Document being requested (cannot be set directly)
|
PROPERTY Query$
Query being passed in URL (information folloing a '?')(cannot be set directly)
|
PROPERTY Port
Port Number (cannot be set directly)
|
PROPERTY Connected
Connected flag. Non-zero is connected (cannot be set directly)
|
PROPERTY TcpChannel
TCP connection channel (cannot be set directly)
|
PROPERTY ContentEncoding$
Value of content-encoding param in response (cannot be set directly)
|
PROPERTY ContentLength
Value of content-length param in response (cannot be set directly)
|
PROPERTY ContentType$
Value of content-type param in response (cannot be set directly)
|
PROPERTY Date$
Value of date param in response (cannot be set directly)
|
PROPERTY Expiration$
Value of expiration param in response (cannot be set directly)
|
PROPERTY LastModified$
Value of last-modified param in response (cannot be set directly)
|
PROPERTY ResponseCode$
String Value of ResponseCode of response such as 200 or 500 (cannot be set directly)
|
PROPERTY ResponseCode
Numeric Value of ResponseCode of response such as 200 or 500 (cannot be set directly)
|
PROPERTY HeaderFields$
List of Header Fields in response (cannot be set directly)
|
PROPERTY RequestProperties$
List of request properties set by SetRequestProperty() (cannot be set directly)
|
|
PROPERTY ChunkedData
|
PROPERTY TimeOut
User set Timeout to wait for communication in seconds (Default=10)
|
Methods
|
FUNCTION connect()
|
|
FUNCTION disconnect()
|
|
FUNCTION setRequestProperty(property$,value$)
|
|
FUNCTION getRequestProperty$(property$)
|
|
FUNCTION getContent$()
|
|
FUNCTION getHeaderField$(fieldName$)
|
Properties inherited from : remx/remxbase
LastErrorMsg$, LastErrorNum$
Methods inherited from : remx/remxbase
EncodeUrl$(), EncodeContent$(), AsciiToUnicode$(), UnicodeToAscii$(), GetLocalIPAddress$(), ParseUrl(), ParseString(), Element$(), GetElement(), SetElement(), EntityToString$(), StringToEntity$(), GetEscapedText$(), \t = The tab character (), \n = The newline (), \r = The carriage-return character (), \f = The form-feed character (), \a = The alert (), \b = The BackSpace character (), \e = The escape character (), ParseEscapedText$()
Class remx/xmlrpcclient
XML-RPC Client Class
When instantiating, either a ServerAddress$ or a ConnectionObject can be passed.
If a ServerAddress$ is passed it must be of the form 'http://<url:port>/<path>' not including the method name.
A remx/httpconnection object will be created to communicate with the server.
If a ConnectionObject is passed into the constructor the object will be used directly to communicate with the remote server.
This class can only be instantiated with a proper RemoteXerver License.
Properties
PROPERTY XmlDefinition$
XML Definition: <?xml version="1.0" encoding="ISO-8859-1"?> (cannot be set directly)
|
PROPERTY Address$
Address of XML-RPC Server in the form 'http://<url:port>/<path>' not including method name (cannot be set directly)
|
PROPERTY Transport$
Internet transport being used such as HTTP (cannot be set directly)
|
PROPERTY MethodName$
XML-RPC method name to execute (cannot be set directly)
|
PROPERTY ParamsXml$
XML representation of the params passed into Execute() (cannot be set directly)
|
PROPERTY RequestXml$
XML request generated by Execute() (cannot be set directly)
|
PROPERTY ResponseText$
Text of the response sent back by the XML-RPC server(cannot be set directly)
|
PROPERTY ResponseArray
remx/array generated by parsing the response text (cannot be set directly)
|
PROPERTY ResponseIolist$
Iolist created from response if using Execute(MethodName$,ParamRec$,IOLst$) (cannot be set directly)
|
PROPERTY ResponseRecord$
Record created from response if using Execute(MethodName$,ParamRec$,IOLst$) (cannot be set directly)
|
PROPERTY FaultCode
Numeric Fault Code returned the XML-RPC server if a fault occurred (cannot be set directly)
|
PROPERTY FaultString$
Fault String returned by the XML-RPC server if a fault occurred (cannot be set directly)
|
Methods
FUNCTION SetAddress(ServerAddress$)
Method to set the Address of the XML-RPC server in the form 'http://<url:port>/<path>' not including the method name.
|
FUNCTION Execute(MethodName$)
Executes the method passed in MethodName at the Address$ property with no parameters passed.
|
FUNCTION Execute(MethodName$,ParamsArray)
Executes the method passed in MethodName using the parameters passed in the remx/array object ParamsArray
|
FUNCTION Execute(MethodName$,ParamRec$,IOLst$)
Executes the method passed in MethodName using the parameter values passed in PVX record format in ParamRec$ mapped to the variable IOLIST in IOList$
|
Properties inherited from : remx/saxparser
LastErrorNum$, LastErrorMsg$
Methods inherited from : remx/saxparser
SetDocumentHandler(), ParseXmlString(), ParseXmlFile(), ParseXmlChannel()
Class remx/xmlrpcservice
XML-RPC Service Class
This class works together with the XmlRpc program. The PVX WebServer runs the XmlRpc program which instantiates this class.
XmlRpc then calls methods to parse out the request and then makes the appropriate calls to the request method provided.
It then gets the results calls against this class to generate the proper response.
This class can only be instantiated with a proper RemoteXerver License.
Properties
PROPERTY RequestArray
RequestArray generated by parsing the XML-RPC document passed into LoadRequestXML() (cannot be set directly)
|
PROPERTY RequestMethodName$
method name of XML-RPC request passed into LoadRequestXML()(cannot be set directly)
|
PROPERTY RequestIolist$
PVX style IOLIST generated by parsing the XML-RPC document passed into LoadRequestXML() (cannot be set directly)
|
PROPERTY RequestRecord$
PVX Record generated by parsing the XML-RPC document passed into LoadRequestXML() (cannot be set directly)
|
PROPERTY ResponseXML$
Response XML-RPC document generated by call to GenerateResponse() (cannot be set directly)
|
PROPERTY FaultCode
Fault Code to return to the calling XML-RPC Client if a fault occured (cannot be set directly)
|
PROPERTY FaultString$
Fault String to return to the calling XML-RPC Client if a fault occured (cannot be set directly)
|
Methods
FUNCTION LoadRequestXML(RequestXML$)
Load and parse the Request XML received by the Web Server
|
FUNCTION GenerateResponse(ResponseRecord$,ResponseIolist$)
Generate an XML-RPC response from a PVX Record and IOLIST
|
FUNCTION GenerateResponse(ResponseArray)
Generate an XML-RPC response from a rem/array object passed in ResponseArray
|
FUNCTION GenerateFaultResponse(FaultCode,FaultString$)
Generate an XML-RPC Fault response using FaultCode and FaultString$
|
Properties inherited from : remx/saxparser
LastErrorNum$, LastErrorMsg$
Methods inherited from : remx/saxparser
SetDocumentHandler(), ParseXmlString(), ParseXmlFile(), ParseXmlChannel()
|