FunctionsNew Method

Linkar Framework .NET (Core and Framework)

Creates one or several records of a file, synchronously only, with XML input and output format.

Namespace: Linkar.Functions.Direct.XML
Assembly: Linkar.Functions.Direct.XML (in Linkar.Functions.Direct.XML.dll) Version: 2.3.1

Syntax

C++

Copy

public static string New(
	CredentialOptions credentialOptions,
	string filename,
	string records,
	NewOptions newOptions = null,
	FunctionsXML_FORMAT xmlFormat = FunctionsXML_FORMAT.XML,
	string customVars = "",
	int receiveTimeout = 0
)

Public Shared Function New ( 
	credentialOptions As CredentialOptions,
	filename As String,
	records As String,
	Optional newOptions As NewOptions = Nothing,
	Optional xmlFormat As FunctionsXML_FORMAT = FunctionsXML_FORMAT.XML,
	Optional customVars As String = "",
	Optional receiveTimeout As Integer = 0
) As String

public:
static String^ New(
	CredentialOptions^ credentialOptions, 
	String^ filename, 
	String^ records, 
	NewOptions^ newOptions = nullptr, 
	FunctionsXML_FORMAT xmlFormat = FunctionsXML_FORMAT::XML, 
	String^ customVars = L"", 
	int receiveTimeout = 0
)

static member New : 
        credentialOptions : CredentialOptions * 
        filename : string * 
        records : string * 
        ?newOptions : NewOptions * 
        ?xmlFormat : FunctionsXML_FORMAT * 
        ?customVars : string * 
        ?receiveTimeout : int 
(* Defaults:
        let _newOptions = defaultArg newOptions null
        let _xmlFormat = defaultArg xmlFormat FunctionsXML_FORMAT.XML
        let _customVars = defaultArg customVars ""
        let _receiveTimeout = defaultArg receiveTimeout 0
*)
-> string

Parameters

credentialOptions CredentialOptions: Object with data necessary to access the Linkar Server: Username, Password, EntryPoint, Language, FreeText.
filename String: The file name where the records are going to be created.
records String: Buffer of records to write. Inside this string are the recordIds, and the records.
newOptions NewOptions (Optional): Object with write options for the new record(s), including recordIdType, readAfter, calculated, dictionaries, conversion, formatSpec, originalRecords.
xmlFormat FunctionsXML_FORMAT (Optional): Different XML output formats.
customVars String (Optional): Free text sent to the database allows management of additional behaviours in SUB.LK.MAIN.CONTROL.CUSTOM, which is called when this parameter is set.
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

String
The results of the operation.

Remarks

Inside the records argument, the records always must be specified. But the recordIds only must be specified when NewOptions argument is null, or when the RecordIdType argument of the NewOptions constructor is null.

Example

C++

Copy

using Linkar;
using Linkar.Functions.Direct.XML;

class Test
    {
        public string MyNew()
        {
            string result = "";
            try
            {
                CredentialOptions credentials = new CredentialOptions("127.0.0.1", "EPNAME", 11300, "admin", "admin");

                result = Functions.New(credentials, "LK.CUSTOMERS",
                    "<?xml version=\"1.0\" encoding=\"utf-16\"?>" +
                    "<LINKAR>" +
                    "  <RECORDS>" +
                    "    <RECORD>" +
                    "      <LKITEMID>2</LKITEMID>" +
                    "      <NAME>CUSTOMER 2</NAME>" +
                    "      <ADDR>ADDRESS 2</ADDR>" +
                    "      <PHONE>444</PHONE>" +
                    "    </RECORD>" +
                    "  </RECORDS>" +
                    "</LINKAR>");
            }
            catch (Exception ex)
            {
                string error = ex.Message;
                // Do something
            }
            return result;
        }
    }

Imports Linkar
Imports Linkar.Functions.Direct.XML

Class Test

    Public Function MyNew() As String
        Dim result As String = ""

        Try
            Dim credentials As CredentialOptions = New CredentialOptions("127.0.0.1", "EPNAME", 11300, "admin", "admin")

            result = Functions.New(credentials, "LK.CUSTOMERS",
                    "<?xml version=\"1.0\" encoding=\"utf-16\"?>" +
                    "<LINKAR>" +
                    "  <RECORDS>" +
                    "    <RECORD>" +
                    "      <LKITEMID>2</LKITEMID>" +
                    "      <NAME>CUSTOMER 2</NAME>" +
                    "      <ADDR>ADDRESS 2</ADDR>" +
                    "      <PHONE>444</PHONE>" +
                    "    </RECORD>" +
                    "  </RECORDS>" +
                    "</LINKAR>")
        Catch ex As Exception

            Dim[error] As String = ex.Message
            ' Do something
        End Try

        Return result
  End Function
End Class

Reference

Functions Class

Linkar.Functions.Direct.XML Namespace