| FunctionsGetVersion Method |
Linkar Framework .NET (Core and Framework)
Allows getting the server version, synchronously only, with XML output format.
Namespace: Linkar.Functions.Direct.XMLAssembly: Linkar.Functions.Direct.XML (in Linkar.Functions.Direct.XML.dll) Version: 2.3.1
Syntax public static string GetVersion(
CredentialOptions credentialOptions,
int receiveTimeout = 0
)
Public Shared Function GetVersion (
credentialOptions As CredentialOptions,
Optional receiveTimeout As Integer = 0
) As String
public:
static String^ GetVersion(
CredentialOptions^ credentialOptions,
int receiveTimeout = 0
)
static member GetVersion :
credentialOptions : CredentialOptions *
?receiveTimeout : int
(* Defaults:
let _receiveTimeout = defaultArg receiveTimeout 0
*)
-> string
Parameters
- credentialOptions CredentialOptions
- Object with data necessary to access the Linkar Server: Username, Password, EntryPoint, Language, FreeText.
- 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
This function returns the following information
- LKMVCOMPONENTSVERSION
- MV Components version.
- LKSERVERVERSION
- Linkar SERVER version.
- LKCLIENTVERSION
- Used client library version.
- DATABASE
- Database.
- OS
- Operating system.
- DATEZERO
- Date zero base in YYYYMMDD format.
- DATEOUTPUTCONVERSION
- Output conversion for date used by Linkar Schemas.
- TIMEOUTPUTCONVERSION
- Output conversion for time used by Linkar Schemas.
- MVDATETIMESEPARATOR
- DateTime used separator used by Linkar Schemas, for instance 18325,23000.
- MVBOOLTRUE
- Database used char for the Boolean true value used by Linkar Schemas.
- MVBOOLFALSE
- Database used char for the Boolean false value used by Linkar Schemas.
- OUTPUTBOOLTRUE
- Used char for the Boolean true value out of the database used by Linkar Schemas.
- OUTPUTBOOLFALSE
- Used char for the Boolean false value out of the database used by Linkar Schemas.
- MVDECIMALSEPARATOR
- Decimal separator in the database. May be point, comma or none when the database does not store decimal numbers. Used by Linkar Schemas.
- OTHERLANGUAGES
- Languages list separated by commas.
- TABLEROWSEPARATOR
- It is the decimal char that you use to separate the rows in the output table format. By default 11.
- TABLECOLSEPARATOR
- It is the decimal char that you use to separate the columns in the output table format. By default 9.
- CONVERTNUMBOOLJSON
- Switch to create numeric and boolean data in JSON strings. Default is false.
Example using Linkar;
using Linkar.Functions.Direct.XML;
class Test
{
public string MyGetVersion()
{
string result = "";
try
{
CredentialOptions credentials = new CredentialOptions("127.0.0.1", "EPNAME", 11300, "admin", "admin");
result = Functions.GetVersion(credentials);
}
catch (Exception ex)
{
string error = ex.Message;
}
return result;
}
}
Imports Linkar
Imports Linkar.Functions.Direct.XML
Class Test
Public Function MyGetVersion() As String
Dim result As String = ""
Try
Dim credentials As CredentialOptions = New CredentialOptions("127.0.0.1", "EPNAME", 11300, "admin", "admin")
result = Functions.GetVersion(credentials)
Catch ex As Exception
Dim[error] As String = ex.Message
End Try
Return result
End Function
End Class
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