ENCX::Library Class Reference

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

import "_encxcom_encx.idl";

Inheritance diagram for ENCX::Library:

[legend]

List of all members.

Public Member Functions
HRESULT	Construct ([in] BSTR OEMKey,[in] BSTR DFSFileName)
	Initialise the ENCX library.
HRESULT	DoIdle ([out, retval] VARIANT_BOOL *bRes)
	Call while the application is idle and while DoIdle() keeps returning true.
Properties
VARIANT_BOOL *	ValidOEMKey [get]
	True if the OEM key supplied when the object was initialized is a valid key.
IDongle **	Dongle [get]
	Get the Dongle object. This object can be queried about the state of the dongle and provides a data encryption service.
BSTR *	DFSInstallationId [get]
	Get the Installation ID string which is used to obtain a Dongle Free Security (DFS) file from CherSoft.
BSTR *	DFSFileName [get]
	The full pathname of the DFS filename.
VARIANT_BOOL *	ValidDFSFile [get]
	Is the DFS file valid (an absence of file is considered invalid).
BSTR *	Version [get]
	Get the version of the library.

---

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 3092 of file _encxcom_encx.idl.

---

Member Function Documentation

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

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

VARIANT_BOOL* ILibrary::ValidOEMKey [get, inherited]

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

IDongle** ILibrary::Dongle [get, inherited]

Get the Dongle object. This object can be queried about the state of the dongle and provides a data encryption service.

BSTR* ILibrary::DFSInstallationId [get, inherited]

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

BSTR* ILibrary::DFSFileName [get, inherited]

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.

VARIANT_BOOL* ILibrary::ValidDFSFile [get, inherited]

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

BSTR* ILibrary::Version [get, inherited]

Get the version of the library.