Interface IGPMessage
- Namespace
- ESRI.ArcGIS.Geodatabase
- Assembly
- ESRI.Server.Geodatabase.dll
Provides access to the properties of a Geoprocessor message.
[InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
[Guid("93D8ACCB-3A6E-4FA2-B283-197EE5D0E334")]
public interface IGPMessage
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
Properties
Description
The description of the geoprocessing message.
string Description { get; set; }
Property Value
Remarks
The get_Description property returns the actual message text string.
ErrorCode
The error code for the geoprocessing message.
int ErrorCode { get; set; }
Property Value
Remarks
The get_ErrorCode property returns the message's error code. It applies only to a message of type esriGPMessageTypeError.
Type
The geoprocessing message type.
esriGPMessageType Type { get; set; }
Property Value
Remarks
The get_Type property returns the message's type. Valid values are defined in the esriGPMessageType enumeration; they are: esriGPMessageTypeInformative, esriGPMessageTypeProcessDefinition, esriGPMessageTypeProcessStart, esriGPMessageTypeProcessStop, esriGPMessageTypeWarning, esriGPMessageTypeAbort, esriGPMessageTypeError, and esriGPMessageTypeEmpty.
Methods
IsAbort()
Indicates if the message is an abort.
bool IsAbort()
Returns
Remarks
The IsAbort method returns true if the message is of type esriGPMessageTypeAbort.
IsError()
Indicates if the message is an error.
bool IsError()
Returns
Remarks
The IsError method returns true if the message is of type esriGPMessageTypeError.
IsInformational()
Indicates if the message is informative.
bool IsInformational()
Returns
Remarks
The IsInformational method returns true if the message is of type esriGPMessageTypeInformative, esriGPMessageTypeProcessDefinition, esriGPMessageTypeProcessStart, and esriGPMessageTypeProcessStop.
IsWarning()
Indicates if the message is a warning.
bool IsWarning()
Returns
Remarks
The IsWarning method returns true if the message is of type esriGPMessageTypeWarning.