ENCX::Library Class Reference

The top level object in the ENCX library. Required to create many other ENCX objects. More...

import"encxcom.idl";

Inheritance diagram for ENCX::Library:

Public Member Functions
HRESULT	Construct ([in] BSTR OEMKey, [in] BSTR DFSFileName)
	Initialise the ENCX library. More...
HRESULT	DoIdle ([out, retval] VARIANT_BOOL *bRes)
	Call while the application is idle and while DoIdle() keeps returning true. More...

Properties
VARIANT_BOOL	ValidOEMKey [get]
	True if the OEM key supplied when the object was initialized is a valid key. More...
IDongle	Dongle [get]
	Get the Dongle object. This object can be queried about the state of the dongle. More...
BSTR	DFSInstallationId [get]
	Get the Installation ID string which is used to obtain a Dongle Free Security (DFS) file from CherSoft. More...
BSTR	DFSFileName [get]
	The full pathname of the DFS filename. More...
VARIANT_BOOL	ValidDFSFile [get]
	Is the DFS file valid (an absence of file is considered invalid) More...
BSTR	Version [get]
	Get the version of the library. More...
IGeoPointFormatter	GeoPointFormatter [get]

Detailed Description

The top level object in the ENCX library. Required to create many other ENCX objects.

To use ENCX to draw a raster chart, create a RasManager and use it to create a RasDraw object. The RasDraw object can be used to draw on a window or bitmap drawing surface via a device context.

Drawing S-57 data is similar; create an S57Manager and use it to create an S57Draw. The S57Draw object can be used to draw on a window or bitmap drawing surface via a device context.

Do not have more than one instance of Library in any one application.

Properties and methods via ILibrary.

Definition at line 3935 of file encxcom.idl.

Member Function Documentation

Construct()

HRESULT ILibrary::Construct ( [in] BSTR  OEMKey, [in] BSTR  DFSFileName  )

inherited

Initialise the ENCX library.

Both parameters can be passed empty strings in which case default values will be used.

If hardware dongles are used the DFS filename should be passed an empty string.

The default OEM key corresponds to a default ENCX product - more information about OEM keys is available on the ENCX website www.encx.com

DoIdle()

HRESULT ILibrary::DoIdle ( [out, retval] VARIANT_BOOL *  bRes )

inherited

Call while the application is idle and while DoIdle() keeps returning true.

Idle processing is not essential to ENCX, but it will improve the scrolling performance for raster charts.

Property Documentation

DFSFileName

BSTR ILibrary::DFSFileName

getinherited

The full pathname of the DFS filename.

The default path is typically in the Application Data special folder.

A different path can be specified using a ILibrary::Construct() parameter.

DFSInstallationId

BSTR ILibrary::DFSInstallationId

getinherited

Get the Installation ID string which is used to obtain a Dongle Free Security (DFS) file from CherSoft.

Dongle

IDongle ILibrary::Dongle

getinherited

Get the Dongle object. This object can be queried about the state of the dongle.

GeoPointFormatter

IGeoPointFormatter ILibrary::GeoPointFormatter

getinherited

ValidDFSFile

VARIANT_BOOL ILibrary::ValidDFSFile

getinherited

Is the DFS file valid (an absence of file is considered invalid)

ValidOEMKey

VARIANT_BOOL ILibrary::ValidOEMKey

getinherited

True if the OEM key supplied when the object was initialized is a valid key.

Version

BSTR ILibrary::Version

getinherited

Get the version of the library.