LinkarCltReadT Method (String, String, String, String, ReadOptions, String, Int32)

public List<T> Read<T>(
	string filename,
	string recordIds,
	string dictionaries,
	string dictClause = "",
	ReadOptions readOptions = null,
	string customVars = "",
	int receiveTimeout = -1
)

Public Function Read(Of T) ( 
	filename As String,
	recordIds As String,
	dictionaries As String,
	Optional dictClause As String = "",
	Optional readOptions As ReadOptions = Nothing,
	Optional customVars As String = "",
	Optional receiveTimeout As Integer = -1
) As List(Of T)

public:
generic<typename T>
List<T>^ Read(
	String^ filename, 
	String^ recordIds, 
	String^ dictionaries, 
	String^ dictClause = L"", 
	ReadOptions^ readOptions = nullptr, 
	String^ customVars = L"", 
	int receiveTimeout = -1
)

member Read : 
        filename : string * 
        recordIds : string * 
        dictionaries : string * 
        ?dictClause : string * 
        ?readOptions : ReadOptions * 
        ?customVars : string * 
        ?receiveTimeout : int 
(* Defaults:
        let _dictClause = defaultArg dictClause ""
        let _readOptions = defaultArg readOptions null
        let _customVars = defaultArg customVars ""
        let _receiveTimeout = defaultArg receiveTimeout -1
*)
-> List<'T> 

Parameters

filename

Type: SystemString
File name to read.

recordIds

Type: SystemString
It's the records codes list to read, separated by the Record Separator character (30).

dictionaries

Type: SystemString

[Missing <param name="dictionaries"/> documentation for "M:LinkarClient.LinkarClt.Read``1(System.String,System.String,System.String,System.String,LinkarCommon.ReadOptions,System.String,System.Int32)"]

dictClause (Optional)

Type: SystemString
List of dictionaries to read, separated by space. If dictionaries are not indicated the function will read the complete buffer.

readOptions (Optional)

Type: LinkarCommonReadOptions
Object that defines the different reading options of the Function: Calculated, dictClause, conversion, formatSpec, originalRecords.

customVars (Optional)

Type: SystemString
It's a free text that will travel until the database to make the admin being able to manage additional behaviours in the standard routine SUB.LK.MAIN.CONTROL.CUSTOM. This routine will be called if the argument has content.

receiveTimeout (Optional)

Type: SystemInt32
It's the maximum time in seconds that the client will keep waiting the answer by the server. By default -1 (wait indefinitely).

Type Parameters

T

Exclusive for .NET & Mono

Some functions can accept and return values directly from a class. These classes must contain extra information in their properties to be able to link with the data sent or received. The data dump regarding the classes is made through reflection, record by record. This means that it will take a little longer to process each record.

For this reason, it is not recommended that a great number of records be obtained at once.

This is achieved through the following metadata:

• MVProperty - This attribute tells the Linkar client that he must try to supply this field with the operations information. The following properties are used to link the feature with its internal value
  • AttributeNumber - Number of the property attribute. It is compulsory to specify this property or the Dictionaryname property.
  • DictionaryName - The name of the property dictionary. It is compulsory to specify this property or AttributeNumber property.
  • InternalType - Data conversions that will be made in the client. None: default value, indicates that the conversion type is not required by the client.
  • InternalDate - The value is saved as an internal date.
  • FormatedDate - The value is saved as a formatted date.
• MVCalculated - The client must try to supply this calculated field with the operations data. The following properties are used to link the feature with its internal value:
  • DictionaryName - The name of the calculated dictionary. This property is mandatory.
  • InternalType - Data conversions that are made in the client
  • None - Default value, a conversion type is not required by the client.
  • InternalDate - Value is saved as an internal date.
  • FormatedDate - Value is saved as a formatted date.
• MVList - This is used on list type objects and indicates that the Linkar client must go across to collect their values and complete them. When situated in the main class is understood that it is a multivalue list, in a secondary class, they will be treated as subvalues, and from there to next they will be ignored.

Return Value

Reference