FunctionsRead Method

Linkar Framework .NET (Core and Framework)

[Missing <summary> documentation for "M:Linkar.Functions.Direct.XML.Functions.Read(Linkar.CredentialOptions,System.String,System.String,System.String,Linkar.Functions.ReadOptions,Linkar.Functions.Direct.XML.Functions.XML_FORMAT,System.String,System.Int32)"]

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 Read(
	CredentialOptions credentialOptions,
	string filename,
	string records,
	string dictionaries = "",
	ReadOptions readOptions = null,
	FunctionsXML_FORMAT xmlFormat = FunctionsXML_FORMAT.XML,
	string customVars = "",
	int receiveTimeout = 0
)

Public Shared Function Read ( 
	credentialOptions As CredentialOptions,
	filename As String,
	records As String,
	Optional dictionaries As String = "",
	Optional readOptions As ReadOptions = Nothing,
	Optional xmlFormat As FunctionsXML_FORMAT = FunctionsXML_FORMAT.XML,
	Optional customVars As String = "",
	Optional receiveTimeout As Integer = 0
) As String

public:
static String^ Read(
	CredentialOptions^ credentialOptions, 
	String^ filename, 
	String^ records, 
	String^ dictionaries = L"", 
	ReadOptions^ readOptions = nullptr, 
	FunctionsXML_FORMAT xmlFormat = FunctionsXML_FORMAT::XML, 
	String^ customVars = L"", 
	int receiveTimeout = 0
)

static member Read : 
        credentialOptions : CredentialOptions * 
        filename : string * 
        records : string * 
        ?dictionaries : string * 
        ?readOptions : ReadOptions * 
        ?xmlFormat : FunctionsXML_FORMAT * 
        ?customVars : string * 
        ?receiveTimeout : int 
(* Defaults:
        let _dictionaries = defaultArg dictionaries ""
        let _readOptions = defaultArg readOptions null
        let _xmlFormat = defaultArg xmlFormat FunctionsXML_FORMAT.XML
        let _customVars = defaultArg customVars ""
        let _receiveTimeout = defaultArg receiveTimeout 0
*)
-> string

Parameters

credentialOptions CredentialOptions: [Missing <param name="credentialOptions"/> documentation for "M:Linkar.Functions.Direct.XML.Functions.Read(Linkar.CredentialOptions,System.String,System.String,System.String,Linkar.Functions.ReadOptions,Linkar.Functions.Direct.XML.Functions.XML_FORMAT,System.String,System.Int32)"]
filename String: [Missing <param name="filename"/> documentation for "M:Linkar.Functions.Direct.XML.Functions.Read(Linkar.CredentialOptions,System.String,System.String,System.String,Linkar.Functions.ReadOptions,Linkar.Functions.Direct.XML.Functions.XML_FORMAT,System.String,System.Int32)"]
records String: [Missing <param name="records"/> documentation for "M:Linkar.Functions.Direct.XML.Functions.Read(Linkar.CredentialOptions,System.String,System.String,System.String,Linkar.Functions.ReadOptions,Linkar.Functions.Direct.XML.Functions.XML_FORMAT,System.String,System.Int32)"]
dictionaries String (Optional): [Missing <param name="dictionaries"/> documentation for "M:Linkar.Functions.Direct.XML.Functions.Read(Linkar.CredentialOptions,System.String,System.String,System.String,Linkar.Functions.ReadOptions,Linkar.Functions.Direct.XML.Functions.XML_FORMAT,System.String,System.Int32)"]
readOptions ReadOptions (Optional): [Missing <param name="readOptions"/> documentation for "M:Linkar.Functions.Direct.XML.Functions.Read(Linkar.CredentialOptions,System.String,System.String,System.String,Linkar.Functions.ReadOptions,Linkar.Functions.Direct.XML.Functions.XML_FORMAT,System.String,System.Int32)"]
xmlFormat FunctionsXML_FORMAT (Optional): [Missing <param name="xmlFormat"/> documentation for "M:Linkar.Functions.Direct.XML.Functions.Read(Linkar.CredentialOptions,System.String,System.String,System.String,Linkar.Functions.ReadOptions,Linkar.Functions.Direct.XML.Functions.XML_FORMAT,System.String,System.Int32)"]
customVars String (Optional): [Missing <param name="customVars"/> documentation for "M:Linkar.Functions.Direct.XML.Functions.Read(Linkar.CredentialOptions,System.String,System.String,System.String,Linkar.Functions.ReadOptions,Linkar.Functions.Direct.XML.Functions.XML_FORMAT,System.String,System.Int32)"]
receiveTimeout Int32 (Optional): [Missing <param name="receiveTimeout"/> documentation for "M:Linkar.Functions.Direct.XML.Functions.Read(Linkar.CredentialOptions,System.String,System.String,System.String,Linkar.Functions.ReadOptions,Linkar.Functions.Direct.XML.Functions.XML_FORMAT,System.String,System.Int32)"]

Return Value

String

[Missing <returns> documentation for "M:Linkar.Functions.Direct.XML.Functions.Read(Linkar.CredentialOptions,System.String,System.String,System.String,Linkar.Functions.ReadOptions,Linkar.Functions.Direct.XML.Functions.XML_FORMAT,System.String,System.Int32)"]

Reference

Functions Class

Linkar.Functions.Direct.XML Namespace