You are here: Symbol Reference
Symbol Reference
> Ofcas.Lk.Api.Client.Ui Namespace > Classes > ServiceProxyBase<TService, TCoreObject> Class > ServiceProxyBase<TService, TCoreObject> Methods > ServiceProxyBase<TService, TCoreObject>.Login Method
Close
Ofcas.Lk.Api.Client - Version 3.0
ContentsContentsIndexIndexHomeHome
PreviousUpNext
ServiceProxyBase<TService, TCoreObject>.Login Method
Send Feedback
Collapse AllCollapse AllExpand AllExpand All

Login to the API to get access to projects, elvations etc. . Without login no access to the API is available. Attention: Before a login is possible, the service must be started (Start).

Syntax
C#
public IDialogResult<TCoreObject> Login(string programMode, IntPtr uiHandle, TimeSpan synchronizeInterval = default(TimeSpan));
Parameters
Description
string programMode
The program mode provided from Orgadata for the associated partner
IntPtr uiHandle
The handle from a window of the user application
TimeSpan synchronizeInterval = default(TimeSpan)
The interval to synchronize the core objects in multi-client mode. If the value is TimeSpan.Zero no synchronization will be active.

The a dialog result with the specific TCoreObject to interact with LogiKal.

Exceptions
Description
ArgumentException
Occurs if any arugment is invalid.
ApiException
Occurs if any error occurs.
Copyright © 2019. All rights reserved.
ContentsIndexHome
What do you think about this topic? Send feedback!