C# Class Opc.Ua.Com.Client.ComClient

Provides access to a COM server.
Inheritance: ComObject
ファイルを表示 Open project: OPCFoundation/UA-.NET Class Usage Examples

Public Methods

Method Description
Close ( ) : void

Gracefully closes the connection to the server.

ComClient ( ComClientConfiguration configuration ) : System

Initializes the object with the ProgID of the server being accessed.

CreateInstance ( ) : void

Creates an instance of the COM server.

GetErrorString ( int error ) : string

Fetches the error string from the server.

QueryAvailableLocales ( ) : int[]

Fetches the available locales.

SelectLocaleId ( IList availableLocaleIds, IList preferredLocales ) : int

Selects the best matching locale id.

SetLocale ( int localeId ) : void

Sets the current locale.

SetUserIdentity ( IUserIdentity identity ) : void

Sets the current user identity.

Protected Methods

Method Description
OnConnected ( ) : void

Called immediately after connecting to the server.

Method Details

Close() public method

Gracefully closes the connection to the server.
public Close ( ) : void
return void

ComClient() public method

Initializes the object with the ProgID of the server being accessed.
public ComClient ( ComClientConfiguration configuration ) : System
configuration ComClientConfiguration
return System

CreateInstance() public method

Creates an instance of the COM server.
public CreateInstance ( ) : void
return void

GetErrorString() public method

Fetches the error string from the server.
public GetErrorString ( int error ) : string
error int
return string

OnConnected() protected method

Called immediately after connecting to the server.
protected OnConnected ( ) : void
return void

QueryAvailableLocales() public method

Fetches the available locales.
public QueryAvailableLocales ( ) : int[]
return int[]

SelectLocaleId() public static method

Selects the best matching locale id.
public static SelectLocaleId ( IList availableLocaleIds, IList preferredLocales ) : int
availableLocaleIds IList
preferredLocales IList
return int

SetLocale() public method

Sets the current locale.
public SetLocale ( int localeId ) : void
localeId int
return void

SetUserIdentity() public method

Sets the current user identity.
public SetUserIdentity ( IUserIdentity identity ) : void
identity IUserIdentity
return void