| DirectCommandsSendXmlCommand Method |
Linkar Framework for .NET and Core
Allows a variety of direct operations using standard XML templates, synchronously only.
Namespace: Linkar.CommandsAssembly: Linkar.Commands (in Linkar.Commands.dll) Version: 2.3.1
Syntax public static string SendXmlCommand(
CredentialOptions credentialOptions,
string command,
int receiveTimeout = 0
)
Public Shared Function SendXmlCommand (
credentialOptions As CredentialOptions,
command As String,
Optional receiveTimeout As Integer = 0
) As String
public:
static String^ SendXmlCommand(
CredentialOptions^ credentialOptions,
String^ command,
int receiveTimeout = 0
)
static member SendXmlCommand :
credentialOptions : CredentialOptions *
command : string *
?receiveTimeout : int
(* Defaults:
let _receiveTimeout = defaultArg receiveTimeout 0
*)
-> string
Parameters
- credentialOptions CredentialOptions
- Object with data necessary to access the Linkar Server: Username, Password, EntryPoint, Language, FreeText.
- command String
- Content of the operation you want to send.
- receiveTimeout Int32 (Optional)
- Maximum time in seconds that the client will wait for a response from the server. Default = 0 to wait indefinitely.
Return Value
StringThe results of the operation.
Example using Linkar;
using Linkar.Commands.Direct;
class Test
{
public string MySendCommand()
{
string result = "";
try
{
CredentialOptions credentials = new CredentialOptions("127.0.0.1", "EPNAME", 11300, "admin", "admin");
string command =
"<COMMAND NAME=\"READ\">" +
" <CALCULATED>True</CALCULATED>" +
" <OUTPUT_FORMAT>XML_DICT</OUTPUT_FORMAT>" +
" <FILE_NAME>LK.CUSTOMERS</FILE_NAME>" +
" <RECORDS>" +
" <RECORD>" +
" <LKITEMID>2</LKITEMID>" +
" </RECORD>" +
" </RECORDS>" +
"</COMMAND>";
result = DirectCommands.SendXmlCommand(credentials, command);
}
catch (Exception ex)
{
string error = ex.Message;
}
return result;
}
}
Imports Linkar
using Linkar.Commands.Direct;
Class Test
Public Function MySendCommand() As String
Dim result As String = ""
Try
Dim credentials As CredentialOptions = New CredentialOptions("127.0.0.1", "EPNAME", 11300, "admin", "admin")
string command =
"<COMMAND NAME=\"READ\">" +
" <CALCULATED>True</CALCULATED>" +
" <OUTPUT_FORMAT>XML_DICT</OUTPUT_FORMAT>" +
" <FILE_NAME>LK.CUSTOMERS</FILE_NAME>" +
" <RECORDS>" +
" <RECORD>" +
" <LKITEMID>2</LKITEMID>" +
" </RECORD>" +
" </RECORDS>" +
"</COMMAND>"
result = DirectCommands.SendXmlCommand(credentials, command)
Catch ex As Exception
Dim[error] As String = ex.Message
End Try
Return result
End Function
End Class
No code example is currently available or this language may not be supported.
No code example is currently available or this language may not be supported.
See Also