Provides access to Geoprocessor messages.
Product Availability
When To Use
The IGPMessages returns the messages that are generated during validation and execution of a geoprocessing tool. The GPMessages object is a container of a collection of GPMessage objects.
For the Validate method, the messages are returned as an array of GPMessage objects. The layout of the returned array is the same as the input array of values, which is the same as the array of tool parameter descriptions.
Also refer to Building Geoprocessing Function Tools .
Members
Description | ||
---|---|---|
Add | Adds a message object to the messages. | |
AddAbort | Adds an abort message to the messages. | |
AddError | Adds an error message to the messages. | |
AddMessage | Adds an informative message to the messages. | |
AddMessages | Adds all messages from an existing messages object to this messages object. | |
AddWarning | Adds a warning message to the messages. | |
Callback | The callback object associated with the GPMessages object. | |
Clear | Clears the message objects from messages object. | |
Count | The message count. | |
GetMessage | Provides a message object from the specified location. | |
InitializeMessages | Creates a number of empty messages and adds them to this messages object. | |
MaxSeverity | The maximum message severity. | |
Messages | The array of message objects. | |
Replace | Replace an existing message in a specified location with a new message object. | |
ReplaceAbort | Creates message of type esriGPMessageTypeAbort and replaces it into a specified position. | |
ReplaceError | Creates message of type esriGPMessageTypeError and replaces it into a specified position. | |
ReplaceMessage | Creates message and replaces it into a specified position. | |
ReplaceWarning | Creates message of type esriGPMessageTypeWarning and replaces it into a specified position. |
CoClasses that implement IGPMessages
CoClasses and Classes | Description |
---|---|
GPMessages |
Remarks
The GPMessages object manages an array of GPMessage objects. This object contains methods to generate and replace message objects. The Validate() method returns a GPMessages object that contains one message for each parameter.
See also IGPMessage