  | DirectFunctionsRead Method | 
Linkar Framework for .NET and Core
            Reads one or several records of a file in synchronous way.
            
Namespace: Linkar.Functions.DirectAssembly: Linkar.Functions.Direct (in Linkar.Functions.Direct.dll) Version: 2.3.1
Syntaxpublic static string Read(
	CredentialOptions credentialOptions,
	string filename,
	string recordIds,
	string dictionaries = "",
	ReadOptions readOptions = null,
	DATAFORMAT_TYPE inputFormat = DATAFORMAT_TYPE.MV,
	DATAFORMATCRU_TYPE outputFormat = DATAFORMATCRU_TYPE.MV,
	string customVars = "",
	int receiveTimeout = 0
)
Public Shared Function Read ( 
	credentialOptions As CredentialOptions,
	filename As String,
	recordIds As String,
	Optional dictionaries As String = "",
	Optional readOptions As ReadOptions = 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:
static String^ Read(
	CredentialOptions^ credentialOptions, 
	String^ filename, 
	String^ recordIds, 
	String^ dictionaries = L"", 
	ReadOptions^ readOptions = nullptr, 
	DATAFORMAT_TYPE inputFormat = DATAFORMAT_TYPE::MV, 
	DATAFORMATCRU_TYPE outputFormat = DATAFORMATCRU_TYPE::MV, 
	String^ customVars = L"", 
	int receiveTimeout = 0
)
static member Read : 
        credentialOptions : CredentialOptions * 
        filename : string * 
        recordIds : string * 
        ?dictionaries : string * 
        ?readOptions : ReadOptions * 
        ?inputFormat : DATAFORMAT_TYPE * 
        ?outputFormat : DATAFORMATCRU_TYPE * 
        ?customVars : string * 
        ?receiveTimeout : int 
(* Defaults:
        let _dictionaries = defaultArg dictionaries ""
        let _readOptions = defaultArg readOptions 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
- credentialOptions  CredentialOptions
 - Object with data necessary to access the Linkar Server: Username, Password, EntryPoint, Language, FreeText.
 - filename  String
 - File name to read.
 - recordIds  String
 - A list of item IDs to read, separated by the Record Separator character (30). Use StringFunctions.ComposeRecordIds to compose this string
 - dictionaries  String  (Optional)
 - List of dictionaries to read, separated by space. If this list is not set, all fields are returned. You may use the format LKFLDx where x is the attribute number.
 - readOptions  ReadOptions  (Optional)
 - Object that defines the different reading options of the Function: Calculated, dictClause, conversion, formatSpec, originalRecords.
 - inputFormat  DATAFORMAT_TYPE  (Optional)
 - Indicates in what format you wish to send the record ids: 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.
See Also