ESRIGridManager Class Reference

An ESRI grid manager object provides functions which facilitate using ESRI grids with MapWinGIS. More...

Collaboration diagram for ESRIGridManager:
Collaboration graph

Public Member Functions

bool CanUseESRIGrids ()
 Gets whether or not MapWinGIS can open ESRI grids. More...
 
bool DeleteESRIGrids (string Filename)
 Deletes the specified ESRI grid. More...
 
string get_ErrorMsg (int ErrorCode)
 Retrieves the error message associated with the specified error code. More...
 
bool IsESRIGrid (string Filename)
 Gets whether or not the specified file is an ESRI grid. More...
 

Properties

ICallback GlobalCallback [get, set]
 The global callback is the interface used by MapWinGIS to pass progress and error events to interested applications. More...
 
int LastErrorCode [get]
 Retrieves the last error generated in the object. More...
 

Detailed Description

An ESRI grid manager object provides functions which facilitate using ESRI grids with MapWinGIS.

The functions and properties are listed below. Clicking on each will yield a description of the function and its arguments as well as sample code where applicable.

Member Function Documentation

◆ CanUseESRIGrids()

bool ESRIGridManager.CanUseESRIGrids ( )

Gets whether or not MapWinGIS can open ESRI grids.

Since ESRI grids are proprietary, MapWinGIS can only open them if another ESRI product has already been installed which provides the files needed to manipulate ESRI grids.

Returns
A boolean value representing whether or not MapWinGIS can open ESRI grids.

◆ DeleteESRIGrids()

bool ESRIGridManager.DeleteESRIGrids ( string  Filename)

Deletes the specified ESRI grid.

Parameters
FilenameThe filename of the ESRI grid to be deleted.
Returns
A boolean value representing the success or failure of deleting the specified ESRI grid.

◆ get_ErrorMsg()

string ESRIGridManager.get_ErrorMsg ( int  ErrorCode)

Retrieves the error message associated with the specified error code.

Parameters
ErrorCodeThe error code for which the error message is required.
Returns
The error message description for the specified error code.

◆ IsESRIGrid()

bool ESRIGridManager.IsESRIGrid ( string  Filename)

Gets whether or not the specified file is an ESRI grid.

Parameters
FilenameThe filename of the grid to be checked.
Returns
A boolean value representing whether or not the specified file is an ESRI grid.

Property Documentation

◆ GlobalCallback

ICallback ESRIGridManager.GlobalCallback
getset

The global callback is the interface used by MapWinGIS to pass progress and error events to interested applications.

Deprecated:
v4.9.3 Use GlobalSettings.ApplicationCallback instead.

◆ LastErrorCode

int ESRIGridManager.LastErrorCode
get

Retrieves the last error generated in the object.