RTS-XQuery Library exposes its functionality using two main Class interfaces
viz :-
1)
RTSLink Class Interface (provides
functionality to push and pull data from Tally Software in XML format)
2)
RTSXQuery Class Interface (provides XQuery Update facility to push XML
data into external databases)
And here's the list of RTS-XQuery library properties and methods :-
|
Class Interface
|
Type |
Method / Property Name
|
Remarks
|
RTSXQuery
|
Method |
Execute |
Parameters : None
Return Value : String
Executes the XQuery and returns the result. In case, if the XQuery is an XQUERY
UPDATE query, the result is an empty string. |
|
Method |
GetFieldMaxValue |
Parameters : strTableName, strFieldName
Return Value : Max-value of strFieldName
Returns the Maximum-value of field "strFieldName" (i.e. 2nd parameter) for the
specified table (i.e. 1st parameter) |
|
Property |
XML |
DataType : String
Type : Read / Write
Specify the XML string. |
|
Property |
XMLFromFile |
DataType : String
Type : Read / Write
Specify the file-name which contains the XML-data. |
|
Property |
XQuery |
DataType : String
Type : Read / Write
Specify the XQuery |
|
Property |
XQueryFromFile |
DataType : String
Type : Read / Write
Specify the file-name which contains the XQuery |
|
Property |
LastErrorNumber |
DataType : Long
Type : Read only
Get the Last Error number |
|
Property |
LastErrorMessage |
DataType : String
Type : Read only
Get the Last Error Message |
|
Property |
ConnectionString |
DataType : String
Type : Read / Write
Specify the connection-string for connecting to external database. |
|
Property |
ApplicationStartupPath |
DataType : String
Type : Read only
Get the Application startup folder |
|
Property |
XQueryProcessor |
DataType : Integer
Type : Read / Write
Get/set the XQuery processor. Valid values are 1,2. The default is 1. |
|
Property |
OmitXMLDeclaration |
DataType : Bool
Type : Read / Write
Specify whether the XML-declaration is required in XQuery result or not. Default
is false. In case of XQuery Update, the value is auomatically set to True. |
|
Property |
SuppressCreateTableErrors |
DataType : Bool
Type : Read / Write
Specify whether the errors generated while executing <createtable> commands are
to be suppressed or not. Default value is True. |
|
Property |
RowsAffected |
DataType : Long
Type : Read only
Returns the number of rows affected by the XQuery. |
|
Property |
ErrorCount |
DataType : String
Type : Read / Write
Returns the number of XQuery statements that generated errors. |
RTSLink |
Method |
Open |
Parameters : None
Return Value : Long
Checks whether Tally software is running. Returns 0 if Tally is running,
otherwise non-zero value. |
|
Method |
Send |
Parameters : strXMLRequest
Return Value : Long
Sends a request (strXMLRequest) to Tally Software. Returns 0 if the message is
successfully sent to Tally, else returns a non-zero value. |
|
Method |
GetResponse |
Parameters : None
Return Value : String
Retrieves the response received from Tally Software. |
|
Method |
SendXMLFileToServer |
Parameters : strXMLFileName
Return Value : Long
Sends a request (contents of strXMLFileName) to Tally Software. Returns 0 if the
message is successfully sent to Tally, else returns a non-zero value. |
|
Method |
SQLRequest |
Parameters : strSQLStatement
Return Value : Long
Sends a request (strSQLStatement) to Tally Software. Returns 0 if the message is
successfully sent to Tally, else returns a non-zero value. |
|
Property |
Port |
DataType : Integer
Type : Read /Write
Get/set the Port |
|
Property |
IPAddress |
DataType : String
Type : Read / Write
Get/set the IP-Address of Tally Server. |
|
Property |
LastErrorNumber |
DataType : Long
Type : Read only
Get the Last Error Number |
|
Property |
LastErrorMessage |
DataType : String
Type : Read only
Get the Last Error Message |
