| DirectFunctionsLkSchemas Method |
Linkar Framework for .NET and Core
Returns a list of all the Schemas defined in Linkar Schemas, or the EntryPoint account data files, synchronously only.
Namespace: Linkar.Functions.DirectAssembly: Linkar.Functions.Direct (in Linkar.Functions.Direct.dll) Version: 2.3.1
Syntax public static string LkSchemas(
CredentialOptions credentialOptions,
LkSchemasOptions lkSchemasOptions = null,
DATAFORMATSCH_TYPE outputFormat = DATAFORMATSCH_TYPE.MV,
string customVars = "",
int receiveTimeout = 0
)
Public Shared Function LkSchemas (
credentialOptions As CredentialOptions,
Optional lkSchemasOptions As LkSchemasOptions = Nothing,
Optional outputFormat As DATAFORMATSCH_TYPE = DATAFORMATSCH_TYPE.MV,
Optional customVars As String = "",
Optional receiveTimeout As Integer = 0
) As String
public:
static String^ LkSchemas(
CredentialOptions^ credentialOptions,
LkSchemasOptions^ lkSchemasOptions = nullptr,
DATAFORMATSCH_TYPE outputFormat = DATAFORMATSCH_TYPE::MV,
String^ customVars = L"",
int receiveTimeout = 0
)
static member LkSchemas :
credentialOptions : CredentialOptions *
?lkSchemasOptions : LkSchemasOptions *
?outputFormat : DATAFORMATSCH_TYPE *
?customVars : string *
?receiveTimeout : int
(* Defaults:
let _lkSchemasOptions = defaultArg lkSchemasOptions null
let _outputFormat = defaultArg outputFormat DATAFORMATSCH_TYPE.MV
let _customVars = defaultArg customVars ""
let _receiveTimeout = defaultArg receiveTimeout 0
*)
-> string
Parameters
- credentialOptions CredentialOptions
[Missing <param name="credentialOptions"/> documentation for "M:Linkar.Functions.Direct.DirectFunctions.LkSchemas(Linkar.CredentialOptions,Linkar.Functions.LkSchemasOptions,Linkar.Functions.DATAFORMATSCH_TYPE,System.String,System.Int32)"]
- lkSchemasOptions LkSchemasOptions (Optional)
- This object defines the different options in base of the asked Schema Type: LKSCHEMAS, SQLMODE o DICTIONARIES.
- outputFormat DATAFORMATSCH_TYPE (Optional)
- Indicates in what format you want to receive the data resulting from the operation: MV, XML, JSON or TABLE.
- 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.
Remarks
TABLE output format uses the defined control characters in
EntryPoints Parameters Table Row Separator and Column Row Separator.
By default:
- TAB char (9) for columns.
- VT char (11) for rows.
See Also