| LinkarClientNew Method |
Linkar Framework for .NET and Core
Creates one or several records of a file, synchronously only.
Namespace: Linkar.Functions.PersistentAssembly: Linkar.Functions.Persistent (in Linkar.Functions.Persistent.dll) Version: 2.3.1
Syntax public string New(
string filename,
string records,
NewOptions newOptions = null,
DATAFORMAT_TYPE inputFormat = DATAFORMAT_TYPE.MV,
DATAFORMATCRU_TYPE outputFormat = DATAFORMATCRU_TYPE.MV,
string customVars = "",
int receiveTimeout = 0
)
Public Function New (
filename As String,
records As String,
Optional newOptions As NewOptions = Nothing,
Optional inputFormat As DATAFORMAT_TYPE = DATAFORMAT_TYPE.MV,
Optional outputFormat As DATAFORMATCRU_TYPE = DATAFORMATCRU_TYPE.MV,
Optional customVars As String = "",
Optional receiveTimeout As Integer = 0
) As String
public:
String^ New(
String^ filename,
String^ records,
NewOptions^ newOptions = nullptr,
DATAFORMAT_TYPE inputFormat = DATAFORMAT_TYPE::MV,
DATAFORMATCRU_TYPE outputFormat = DATAFORMATCRU_TYPE::MV,
String^ customVars = L"",
int receiveTimeout = 0
)
member New :
filename : string *
records : string *
?newOptions : NewOptions *
?inputFormat : DATAFORMAT_TYPE *
?outputFormat : DATAFORMATCRU_TYPE *
?customVars : string *
?receiveTimeout : int
(* Defaults:
let _newOptions = defaultArg newOptions null
let _inputFormat = defaultArg inputFormat DATAFORMAT_TYPE.MV
let _outputFormat = defaultArg outputFormat DATAFORMATCRU_TYPE.MV
let _customVars = defaultArg customVars ""
let _receiveTimeout = defaultArg receiveTimeout 0
*)
-> string
Parameters
- 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. Use StringFunctions.ComposeNewBuffer (Linkar.Strings library) function to compose this string.
- newOptions NewOptions (Optional)
- Object with write options for the new record(s), including recordIdType, readAfter, calculated, dictionaries, conversion, formatSpec, originalRecords.
- inputFormat DATAFORMAT_TYPE (Optional)
- Indicates in what format you wish to send the resultant writing data: MV, XML or JSON.
- outputFormat DATAFORMATCRU_TYPE (Optional)
- Indicates in what format you want to receive the data resulting from the Read, New, Update and Select operations: MV, XML, XML_DICT, XML_SCH, JSON, JSON_DICT or JSON_SCH.
- 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
StringThe 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.
See Also