| LinkarCltLkProperties Method (String, LkPropertiesOptions, String, Int32) |
Returns the Schema properties list defined in Linkar Schemas or the file dictionaries, in a Synchronous way.
Persistent Method.
Namespace:
LinkarClient
Assemblies:
LinkarClientCore (in LinkarClientCore.dll) Version: 2.1.0.0
LinkarClientMono (in LinkarClientMono.dll) Version: 2.1.0.0 (2.1.0.0)
LinkarClient (in LinkarClient.dll) Version: 2.1.0.0 (2.1.0.0)
Syntax public LkData LkProperties(
string filename,
LkPropertiesOptions lkPropertiesOptions = null,
string customVars = "",
int receiveTimeout = -1
)
Public Function LkProperties (
filename As String,
Optional lkPropertiesOptions As LkPropertiesOptions = Nothing,
Optional customVars As String = "",
Optional receiveTimeout As Integer = -1
) As LkData
public:
LkData^ LkProperties(
String^ filename,
LkPropertiesOptions^ lkPropertiesOptions = nullptr,
String^ customVars = L"",
int receiveTimeout = -1
)
member LkProperties :
filename : string *
?lkPropertiesOptions : LkPropertiesOptions *
?customVars : string *
?receiveTimeout : int
(* Defaults:
let _lkPropertiesOptions = defaultArg lkPropertiesOptions null
let _customVars = defaultArg customVars ""
let _receiveTimeout = defaultArg receiveTimeout -1
*)
-> LkData
Parameters
- filename
- Type: SystemString
File name to LkProperties - lkPropertiesOptions (Optional)
- Type: LinkarCommonLkPropertiesOptions
This object defines the different options in base of the asked Schema Type: LKSCHEMAS, SQLMODE o DICTIONARIES. - 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).
Return Value
Type:
LkDataReturns an object of type
LkData with the results of the operation.
Exceptions Exception | Condition |
---|
SocketException | Thrown when there are communication problems between LINKAR Client and LINKAR Server |
LkException | Thrown when there are errors in LINKAR Client or LINKAR Server |
Examples LinkarClt lkClt = new LinkarClt();
CredentialsOptions crdOpt = new CredentialsOptions("127.0.0.1", 11300, "admin", "admin", "ENTRYPOINT");
lkClt.Login(crdOpt);
string filename = "LK.CUSTOMERS";
ROWHEADERS_TYPE rowHeaders = ROWHEADERS_TYPE.MAINLABEL;
bool rowProperties = true;
bool onlyVisibles = true;
bool usePropertyNames = true;
LkPropertiesOptions optProSchTypeLk = new LkPropertiesOptions(rowHeaders, rowProperties, onlyVisibles, usePropertyNames);
LkData lkDataLkProperties = lkClt.LkProperties(filename, optProSchTypeLk);
LkPropertiesOptions optProSchTypeSql = new LkPropertiesOptions(onlyVisibles);
LkData lkDataLkProperties2 = lkClt.LkProperties(filename, optProSchTypeSql);
LkPropertiesOptions optProSchTypeDict = new LkPropertiesOptions(rowHeaders);
LkData lkDataLkProperties3 = lkClt.LkProperties(filename, optProSchTypeDict);
Dim lkClt As LinkarClt = New LinkarClt()
Dim crdOpt As CredentialsOptions = New CredentialsOptions("127.0.0.1", 11300, "admin", "admin", "ENTRYPOINT")
lkClt.Login(crdOpt)
Dim filename As String = "LK.CUSTOMERS"
Dim rowHeaders As ROWHEADERS_TYPE = ROWHEADERS_TYPE.MAINLABEL
Dim rowProperties As Boolean = True
Dim onlyVisibles As Boolean = True
Dim usePropertyNames As Boolean = True
Dim optProSchTypeLk As LkPropertiesOptions = New LkPropertiesOptions(rowHeaders, rowProperties, onlyVisibles, usePropertyNames)
Dim lkDataLkProperties As LkData = lkClt.LkProperties(filename, optProSchTypeLk)
Dim optProSchTypeSql As LkPropertiesOptions = New LkPropertiesOptions(onlyVisibles)
Dim lkDataLkProperties2 As LkData = lkClt.LkProperties(filename, optProSchTypeSql)
Dim optProSchTypeDict As LkPropertiesOptions = New LkPropertiesOptions(rowHeaders)
Dim lkDataLkProperties3 As LkData = lkClt.LkProperties(filename, optProSchTypeDict)
No code example is currently available or this language may not be supported.
No code example is currently available or this language may not be supported.
See Also