Interface IGPMessages

Namespace
ESRI.ArcGIS.Geodatabase
Assembly
ESRI.Server.Geodatabase.dll

Provides access to Geoprocessor messages.

[Guid("0696AA9D-C26B-4A3E-89B7-3763EA11F16C")]
[InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
public interface IGPMessages

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

Properties

Callback

The callback object associated with the GPMessages object.

IGPMessagesCallback Callback { get; set; }

Property Value

IGPMessagesCallback

Count

The message count.

int Count { get; }

Property Value

int

Remarks

The get_Count property returns the number of GPMessage objects in this collection.

MaxSeverity

The maximum message severity.

esriGPMessageSeverity MaxSeverity { get; }

Property Value

esriGPMessageSeverity

Remarks

The get_MaxSeverity property returns the highest message type class in this collection. Valid values are defined and stored in the enumeration esriGPMessageSeverity ; they are: esriGPMessageSeverityInformative, esriGPMessageSeverityWarning, esriGPMessageSeverityError, and esriGPMessageSeverityAbort .

Messages

The array of message objects.

IArray Messages { get; }

Property Value

IArray

Remarks

The get_Messages property returns all the GPMessage objects in this collection.

Methods

Add(IGPMessage)

Adds a message object to the messages.

void Add(IGPMessage msg)

Parameters

msg IGPMessage

Remarks

The Add method adds a GPMessage object to the GPMessages collection.

AddAbort(string)

Adds an abort message to the messages.

void AddAbort(string Message)

Parameters

Message string

Remarks

The AddAbort method creates a GPMessage of type esriGPMEssageTypeAbort and adds it to this collection.

AddError(int, string)

Adds an error message to the messages.

void AddError(int ErrorCode, string Message)

Parameters

ErrorCode int
Message string

Remarks

The AddError method creates a GPMessage of type esriGPMEssageTypeError and adds it to this collection.

AddMessage(string)

Adds an informative message to the messages.

void AddMessage(string Message)

Parameters

Message string

Remarks

The AddMessage method creates a GPMessage of type esriGPMEssageTypeInformative and adds it to this collection.

AddMessages(IGPMessages)

Adds all messages from an existing messages object to this messages object.

void AddMessages(IGPMessages Messages)

Parameters

Messages IGPMessages

Remarks

The AddMessages method adds all messages from the input collection to this collection.

AddWarning(string)

Adds a warning message to the messages.

void AddWarning(string Message)

Parameters

Message string

Remarks

The AddWarning method creates a GPMessage of type esriGPMEssageTypeWarning and adds it to this collection.

Clear()

Clears the message objects from messages object.

void Clear()

Remarks

The Clear method empties a collection of GPMessage objects.

GetMessage(int)

Provides a message object from the specified location.

IGPMessage GetMessage(int Index)

Parameters

Index int

Returns

IGPMessage

Remarks

The GetMessage property returns the specified GPMessage object from this collection. 

InitializeMessages(int)

Creates a number of empty messages and adds them to this messages object.

void InitializeMessages(int nMessages)

Parameters

nMessages int

Remarks

The InitializeMessages method creates a number of empty messages and adds them to this collection.

Replace(int, IGPMessage)

Replace an existing message in a specified location with a new message object.

void Replace(int Index, IGPMessage msg)

Parameters

Index int
msg IGPMessage

Remarks

The Replace method replaces a message into a specified position in this GPMessages collection.

ReplaceAbort(int, string)

Creates message of type esriGPMessageTypeAbort and replaces it into a specified position.

void ReplaceAbort(int Index, string Message)

Parameters

Index int
Message string

Remarks

The ReplaceAbort method creates a GPMessage of type esriGPMEssageTypeAbort and replaces it into a specified position in this GPMessages collection.

ReplaceError(int, int, string)

Creates message of type esriGPMessageTypeError and replaces it into a specified position.

void ReplaceError(int Index, int ErrorCode, string Message)

Parameters

Index int
ErrorCode int
Message string

Remarks

The ReplaceError method creates a GPMessage of type esriGPMEssageTypeError and replaces it into a specified position in this GPMessages collection.

ReplaceMessage(int, string)

Creates message and replaces it into a specified position.

void ReplaceMessage(int Index, string Message)

Parameters

Index int
Message string

Remarks

The ReplaceMessage method creates a GPMessage of type esriGPMEssageTypeInformative and replaces it into a specified position in this GPMessages collection.

ReplaceWarning(int, string)

Creates message of type esriGPMessageTypeWarning and replaces it into a specified position.

void ReplaceWarning(int Index, string Message)

Parameters

Index int
Message string

Remarks

The ReplaceWarning method creates a GPMessage of type esriGPMEssageTypeWarning and replaces it into a specified position in this GPMessages collection.