Click or drag to resize

LinkarCltSendCommand_Text Method (CredentialsOptions, String, ENVELOPE_FORMAT, Int32)

Allows making different operations, through some templates in standar format (XML, JSON), in a Synchronous way.
Direct Method.

Namespace:  LinkarClient
Assemblies:   LinkarClientCore (in LinkarClientCore.dll) Version: 2.1.0.0
  LinkarClientMono (in LinkarClientMono.dll) Version: 2.1.0.0 (2.1.0.0)
  LinkarClient (in LinkarClient.dll) Version: 2.1.0.0 (2.1.0.0)
Syntax
Copy
public static string SendCommand_Text(
	CredentialsOptions credentialsOptions,
	string command,
	ENVELOPE_FORMAT commandFormat = ENVELOPE_FORMAT.XML,
	int receiveTimeout = 0
)

Parameters

credentialsOptions
Type: LinkarCommonCredentialsOptions
Object that defines the necessary data to access to the Linkar Server: Username, Password, EntryPoint, Language, FreeText.
command
Type: SystemString
Content of the operation you want to send.
commandFormat (Optional)
Type: LinkarCommonENVELOPE_FORMAT
Indicates in what format you are doing the operation: XML or JSON.
receiveTimeout (Optional)
Type: SystemInt32
It's the maximum time in seconds that the client will keep waiting the answer by the server. By default -1 (wait indefinitely).

Return Value

Type: String
Returns an string, (XML or JSON formatted) with the results of the operation.
Exceptions
ExceptionCondition
SocketException

Thrown when there are communication problems between LINKAR Client and LINKAR Server

LkException

Thrown when there are errors in LINKAR Client or LINKAR Server

Remarks
The command argument is a string of characters where you specify the operation, along with your options, that you want to execute. To facilitate the use of SendCommand, a list of templates is provided for each operation along with all its options. You can consult the XML and JSON templates herehttps://github.com/kosday/Linkar-from-Operating-System-shell-lksendcomand-command_self
Examples
Copy
CredentialsOptions crdOpt = new CredentialsOptions("127.0.0.1", 11300, "admin", "admin", "ENTRYPOINT");

string commandTemplate = 
"<COMMAND NAME=\"READ\">\r\n" +
  " <CALCULATED>False</CALCULATED>\r\n" +
  "    <DICTIONARIES>False</DICTIONARIES>\r\n" +
  "    <CONVERSION>False</CONVERSION>\r\n" +
  "    <FORMAT_SPEC>False</FORMAT_SPEC>\r\n" +
  "    <ORIGINAL_RECORDS>False</ORIGINAL_RECORDS>\r\n" +
  "    <CUSTOM_VARS></CUSTOM_VARS>\r\n" +
  "    <OUTPUT_FORMAT>MV</OUTPUT_FORMAT>\r\n" +
  "    <FILE_NAME>LK.CUSTOMERS</FILE_NAME>\r\n" +
  "    <RECORD_IDS>\r\n" +
  "        <ID>2</ID>\r\n" +
  "    </RECORD_IDS>\r\n" +
  "    <RECORD_DICTCLAUSE></RECORD_DICTCLAUSE>\r\n" +
"</COMMAND>";
ENVELOPE_FORMAT commandFormat = ENVELOPE_FORMAT.XML;
string result = LinkarClt.SendCommand_Text(crdOpt, commandTemplate, commandFormat);
See Also