This document is archived and information here might be outdated.  Recommended version.


IGPMessage Interface (ArcObjects .NET 10.5 SDK)
ArcObjects Help for .NET developers > ArcObjects namespaces > Geodatabase > ESRI.ArcGIS.GeoDatabase > Interfaces > IG > IGPMessage Interface (ArcObjects .NET 10.5 SDK)
ArcObjects Library Reference (GeoDatabase)  

IGPMessage Interface

Provides access to the properties of a Geoprocessor message.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

When To Use

The IGPMessage interface returns a GPMessage object from an IGPMessages array, a collection of GPMessage objects. Messages are returned during the validating and executing of a geoprocessing tool.

Also refer to Building Geoprocessing Function Tools.

Members

Description
Read/write property Description The description of the geoprocessing message.
Read/write property ErrorCode The error code for the geoprocessing message.
Method IsAbort Indicates if the message is an abort.
Method IsError Indicates if the message is an error.
Method IsInformational Indicates if the message is informative.
Method IsWarning Indicates if the message is a warning.
Read/write property Type The geoprocessing message type.

CoClasses that implement IGPMessage

CoClasses and Classes Description
GPMessage
GPMessages

Remarks

The GPMessage object is composed of a message type, error code, and description. The message type can be Error,  Warning, or Informative.

 

See also IGPMessages

.NET Samples

Closest facility solver (Code Files: frmClosestFacilitySolver) | Service area solver (Code Files: frmServiceAreaSolver) | Location-allocation solver (Code Files: frmLocationAllocationSolver) | Vehicle routing problem solver (Code Files: frmVRPSolver) | Executing geoprocessing tools in the background (Code Files: RunGPForm) | Calculate area geoprocessing function tool (Code Files: CalculateAreaFunction) | Geoprocessing events listener (Code Files: GPEventHelper)