Please enable JavaScript to view this site.

Navigation: Linkar CLIENTS > Client Functions

New, New_Text, NewAsync, NewAsync_Text

Scroll Prev Top Next More

Creates one or more new file records, synchronously or asynchronously.

 

 

* hasError

(only C)

BOOL*

 

Only in C functions: bool pointer used in the C functions that indicates the return of the function is a system error and must be communicated to the Linkar SERVER

 

* callback

 

OperationAsyncCallbackString

OperationAsyncCallbackLkData

OperationAsyncCallbackClass

ArrayList

 

 

Return type in asynchronous methods. For further information see ASYNCHRONOUS CALLS

* credentialsOptions

CredentialsOptions

char*

 

 

Object that defines the necessary data to access the database: Username, Password, EntryPoint, Language, FreeText. In the C Direct Functions, it is a char*

* connectionInfo

(only C)

char*

 

Only in C Persistent Functions: string that is returned by the Login function and contains all the necessary connection data. This data is necessary in persistent functions.

 

* filename

string

char*

 

 

File name to write.

* recordIds

string

char*

 

 

The list of record keys, separated by the Record Separator character (30) : LinkarCommon.ASCII_Chars.RS.

If empty, use the newOptions parameter below.

 

* records

 

string

 

Dynamic array records to be created, separated by the Record Separator character (30) : LinkarCommon.ASCII_Chars.RS.

newOptions

NewOptions

char*

 

null

Nothing

 

Object of type NewOptions provides details about how the delete operation(s) will be done.

inputStringType

 

enum DataFormat.TYPE

typedef uint8_t DataFormatTYPE;

 

DataFormat.TYPE.MV

 

 

Format of the data being used to create new record(s) : MV, XML or JSON.

 

outputStringType

enum DataFormat.TYPE

typedef uint8_t DataFormatTYPE;

 

DataFormat.TYPE.MV

 

 

Format of the data to be returned: MV, XML, XML_DICT, XML_JSCH, JSON, JSON_DICT, JSON_SCH.

 

customVars

string

char*

optional

This is a free text field to send in the transaction. If not empty, subroutine SUB.LK.MAIN.CONTROL.CUSTOM will be called. Add custom code to that subroutine to define special behaviours for some or all transactions.

 

receiveTimeout

Numeric

 

-1

0

 

This is the maximum time in seconds that the client will wait for a response. Use 0 for no timeout. This is a function-specific override : -1 in a Persistent function defaults back to the timeout defined in the LinkarClt constructor.

 

 

This function can generate exceptions.

In COM assemblies, a return value of type String will contain an error message if an error occurs when performing the operation.

 

When used in the shared/static form for Direct/Volatile transactions, a credentialsOptions object is required, created as an instance of the CredentialsOptions class.

 

The NewOptions object has a property for a NewRecordIdType object. If this property is null, the recordlds must be specified. See NewRecordIdType.

 

       New. Persistent Functions

       New. Direct Functions

       NewAsync. Persistent Functions

       NewAsync. Direct Functions