com.esri.arcgis.geodatabase
Class GPMessages

java.lang.Object
  extended by com.esri.arcgis.geodatabase.GPMessages
All Implemented Interfaces:
IGPMessage, IGPMessages, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, IXMLSerialize, Externalizable, Serializable

public class GPMessages
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IGPMessage, IGPMessages, IClone, IPersistStream, IXMLSerialize, Externalizable

Remarks

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 .

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
Serialized Form

Constructor Summary
GPMessages()
          Constructs a GPMessages using ArcGIS Engine.
GPMessages(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GPMessages theGPMessages = (GPMessages) obj;
 
Method Summary
 void add(IGPMessage msg)
          Adds a message object to the messages.
 void addAbort(String message)
          Adds an abort message to the messages.
 void addError(int errorCode, String message)
          Adds an error message to the messages.
 void addMessage(String message)
          Adds an informative message to the messages.
 void addMessages(IGPMessages messages)
          Adds all messages from an existing messages object to this messages object.
 void addWarning(String message)
          Adds a warning message to the messages.
 void assign(IClone src)
          Assigns the properties of src to the receiver.
 void clear()
          Clears the message objects from messages object.
 void deserialize(IXMLSerializeData data)
          Deserializes an object from XML.
 boolean equals(Object o)
          Compare this object with another
 IClone esri_clone()
          Clones the receiver and assigns the result to *clone.
 IGPMessagesCallback getCallback()
          The callback object associated with the GPMessages object.
 void getClassID(GUID[] pClassID)
          getClassID
static String getClsid()
          getClsid.
 int getCount()
          The message count.
 String getDescription()
          The description of the geoprocessing message.
 int getErrorCode()
          The error code for the geoprocessing message.
 int getMaxSeverity()
          The maximum message severity.
 IGPMessage getMessage(int index)
          Provides a message object from the specified location.
 IArray getMessages()
          The array of message objects.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 int getType()
          The geoprocessing message type.
 int hashCode()
          the hashcode for this object
 void initializeMessages(int nMessages)
          Creates a number of empty messages and adds them to this messages object.
 boolean isAbort()
          Indicates if the message is an abort.
 void isDirty()
          isDirty
 boolean isEqual(IClone other)
          Returns TRUE when the receiver and other have the same properties.
 boolean isError()
          Indicates if the message is an error.
 boolean isIdentical(IClone other)
          Returns TRUE when the receiver and other are the same object.
 boolean isInformational()
          Indicates if the message is informative.
 boolean isWarning()
          Indicates if the message is a warning.
 void load(IStream pstm)
          load
 void readExternal(ObjectInput in)
           
 void replace(int index, IGPMessage msg)
          Replace an existing message in a specified location with a new message object.
 void replaceAbort(int index, String message)
          Creates message of type esriGPMessageTypeAbort and replaces it into a specified position.
 void replaceError(int index, int errorCode, String message)
          Creates message of type esriGPMessageTypeError and replaces it into a specified position.
 void replaceMessage(int index, String message)
          Creates message and replaces it into a specified position.
 void replaceWarning(int index, String message)
          Creates message of type esriGPMessageTypeWarning and replaces it into a specified position.
 void save(IStream pstm, int fClearDirty)
          save
 void serialize(IXMLSerializeData data)
          Serializes an object to XML.
 void setCallbackByRef(IGPMessagesCallback messagesCallback)
          The callback object associated with the GPMessages object.
 void setDescription(String message)
          The description of the geoprocessing message.
 void setErrorCode(int errorCode)
          The error code for the geoprocessing message.
 void setType(int type)
          The geoprocessing message type.
 void writeExternal(ObjectOutput out)
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef
getJintegraDispatch, release
 

Constructor Detail

GPMessages

public GPMessages()
           throws IOException,
                  UnknownHostException
Constructs a GPMessages using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

GPMessages

public GPMessages(Object obj)
           throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GPMessages theGPMessages = (GPMessages) obj;

Construct a GPMessages using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to GPMessages.

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
IOException - if there are interop problems
Method Detail

getClsid

public static String getClsid()
getClsid.


equals

public boolean equals(Object o)
Compare this object with another

Overrides:
equals in class Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class Object

setType

public void setType(int type)
             throws IOException,
                    AutomationException
The geoprocessing message type.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setType in interface IGPMessage
Parameters:
type - A com.esri.arcgis.geodatabase.esriGPMessageType constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getType

public int getType()
            throws IOException,
                   AutomationException
The geoprocessing message type.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getType in interface IGPMessage
Returns:
A com.esri.arcgis.geodatabase.esriGPMessageType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setErrorCode

public void setErrorCode(int errorCode)
                  throws IOException,
                         AutomationException
The error code for the geoprocessing message.

Remarks

The ErrorCode property returns the error code for a given message. It applies only to messages of type error.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setErrorCode in interface IGPMessage
Parameters:
errorCode - The errorCode (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getErrorCode

public int getErrorCode()
                 throws IOException,
                        AutomationException
The error code for the geoprocessing message.

Remarks

The get_ErrorCode property returns the message's error code. It applies only to a message of type esriGPMessageTypeError.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getErrorCode in interface IGPMessage
Returns:
The errorCode
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDescription

public void setDescription(String message)
                    throws IOException,
                           AutomationException
The description of the geoprocessing message.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setDescription in interface IGPMessage
Parameters:
message - The message (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDescription

public String getDescription()
                      throws IOException,
                             AutomationException
The description of the geoprocessing message.

Remarks

The get_Description property returns the actual message text string.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getDescription in interface IGPMessage
Returns:
The message
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isInformational

public boolean isInformational()
                        throws IOException,
                               AutomationException
Indicates if the message is informative.

Remarks

The IsInformational method returns true if the message is of type esriGPMessageTypeInformative, esriGPMessageTypeProcessDefinition, esriGPMessageTypeProcessStart, and esriGPMessageTypeProcessStop.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isInformational in interface IGPMessage
Returns:
The isInformational
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isWarning

public boolean isWarning()
                  throws IOException,
                         AutomationException
Indicates if the message is a warning.

Remarks

The IsWarning method returns true if the message is of type esriGPMessageTypeWarning.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isWarning in interface IGPMessage
Returns:
The isWarning
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isError

public boolean isError()
                throws IOException,
                       AutomationException
Indicates if the message is an error.

Remarks

The IsError method returns true if the message is of type esriGPMessageTypeError.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isError in interface IGPMessage
Returns:
The isError
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isAbort

public boolean isAbort()
                throws IOException,
                       AutomationException
Indicates if the message is an abort.

Remarks

The IsAbort method returns true if the message is of type esriGPMessageTypeAbort.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isAbort in interface IGPMessage
Returns:
The isAbort
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCallbackByRef

public void setCallbackByRef(IGPMessagesCallback messagesCallback)
                      throws IOException,
                             AutomationException
The callback object associated with the GPMessages object.

Product Availability

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

Specified by:
setCallbackByRef in interface IGPMessages
Parameters:
messagesCallback - A reference to a com.esri.arcgis.geodatabase.IGPMessagesCallback (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCallback

public IGPMessagesCallback getCallback()
                                throws IOException,
                                       AutomationException
The callback object associated with the GPMessages object.

Product Availability

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

Specified by:
getCallback in interface IGPMessages
Returns:
A reference to a com.esri.arcgis.geodatabase.IGPMessagesCallback
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

clear

public void clear()
           throws IOException,
                  AutomationException
Clears the message objects from messages object.

Remarks

The Clear method empties a collection of GPMessage objects.

Product Availability

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

Specified by:
clear in interface IGPMessages
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

add

public void add(IGPMessage msg)
         throws IOException,
                AutomationException
Adds a message object to the messages.

Remarks

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

Product Availability

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

Specified by:
add in interface IGPMessages
Parameters:
msg - A reference to a com.esri.arcgis.geodatabase.IGPMessage (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addWarning

public void addWarning(String message)
                throws IOException,
                       AutomationException
Adds a warning message to the messages.

Remarks

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

Product Availability

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

Specified by:
addWarning in interface IGPMessages
Parameters:
message - The message (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addAbort

public void addAbort(String message)
              throws IOException,
                     AutomationException
Adds an abort message to the messages.

Remarks

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

Product Availability

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

Specified by:
addAbort in interface IGPMessages
Parameters:
message - The message (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addError

public void addError(int errorCode,
                     String message)
              throws IOException,
                     AutomationException
Adds an error message to the messages.

Remarks

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

Product Availability

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

Specified by:
addError in interface IGPMessages
Parameters:
errorCode - The errorCode (in)
message - The message (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addMessage

public void addMessage(String message)
                throws IOException,
                       AutomationException
Adds an informative message to the messages.

Remarks

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

Product Availability

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

Specified by:
addMessage in interface IGPMessages
Parameters:
message - The message (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addMessages

public void addMessages(IGPMessages messages)
                 throws IOException,
                        AutomationException
Adds all messages from an existing messages object to this messages object.

Remarks

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

Product Availability

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

Specified by:
addMessages in interface IGPMessages
Parameters:
messages - A reference to a com.esri.arcgis.geodatabase.IGPMessages (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

initializeMessages

public void initializeMessages(int nMessages)
                        throws IOException,
                               AutomationException
Creates a number of empty messages and adds them to this messages object.

Remarks

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

Product Availability

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

Specified by:
initializeMessages in interface IGPMessages
Parameters:
nMessages - The nMessages (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

replace

public void replace(int index,
                    IGPMessage msg)
             throws IOException,
                    AutomationException
Replace an existing message in a specified location with a new message object.

Remarks

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

Product Availability

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

Specified by:
replace in interface IGPMessages
Parameters:
index - The index (in)
msg - A reference to a com.esri.arcgis.geodatabase.IGPMessage (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

replaceError

public void replaceError(int index,
                         int errorCode,
                         String message)
                  throws IOException,
                         AutomationException
Creates message of type esriGPMessageTypeError and replaces it into a specified position.

Remarks

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

Product Availability

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

Specified by:
replaceError in interface IGPMessages
Parameters:
index - The index (in)
errorCode - The errorCode (in)
message - The message (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

replaceWarning

public void replaceWarning(int index,
                           String message)
                    throws IOException,
                           AutomationException
Creates message of type esriGPMessageTypeWarning and replaces it into a specified position.

Remarks

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

Product Availability

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

Specified by:
replaceWarning in interface IGPMessages
Parameters:
index - The index (in)
message - The message (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

replaceAbort

public void replaceAbort(int index,
                         String message)
                  throws IOException,
                         AutomationException
Creates message of type esriGPMessageTypeAbort and replaces it into a specified position.

Remarks

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

Product Availability

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

Specified by:
replaceAbort in interface IGPMessages
Parameters:
index - The index (in)
message - The message (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

replaceMessage

public void replaceMessage(int index,
                           String message)
                    throws IOException,
                           AutomationException
Creates message and replaces it into a specified position.

Remarks

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

Product Availability

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

Specified by:
replaceMessage in interface IGPMessages
Parameters:
index - The index (in)
message - The message (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCount

public int getCount()
             throws IOException,
                    AutomationException
The message count.

Remarks

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

Product Availability

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

Specified by:
getCount in interface IGPMessages
Returns:
The count
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMessage

public IGPMessage getMessage(int index)
                      throws IOException,
                             AutomationException
Provides a message object from the specified location.

Remarks

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

Product Availability

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

Specified by:
getMessage in interface IGPMessages
Parameters:
index - The index (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IGPMessage
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMessages

public IArray getMessages()
                   throws IOException,
                          AutomationException
The array of message objects.

Remarks

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

Product Availability

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

Specified by:
getMessages in interface IGPMessages
Returns:
A reference to a com.esri.arcgis.system.IArray
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMaxSeverity

public int getMaxSeverity()
                   throws IOException,
                          AutomationException
The maximum message severity.

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 .

Product Availability

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

Specified by:
getMaxSeverity in interface IGPMessages
Returns:
A com.esri.arcgis.geodatabase.esriGPMessageSeverity constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws IOException,
                         AutomationException
Clones the receiver and assigns the result to *clone.

Product Availability

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

Specified by:
esri_clone in interface IClone
Returns:
A reference to a com.esri.arcgis.system.IClone
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws IOException,
                   AutomationException
Assigns the properties of src to the receiver.

Description

Use Assign method to assign the properties of source object to receiver object. Both objects need to have the same CLSIDs. Both source and receiver objects need to be instantiated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
assign in interface IClone
Parameters:
src - A reference to a com.esri.arcgis.system.IClone (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws IOException,
                       AutomationException
Returns TRUE when the receiver and other have the same properties.

Description

IsEqual returns True if the receiver and the source have the same properties. Note, this does not imply that the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isEqual in interface IClone
Parameters:
other - A reference to a com.esri.arcgis.system.IClone (in)
Returns:
The equal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws IOException,
                           AutomationException
Returns TRUE when the receiver and other are the same object.

Description

IsIdentical returns true if the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isIdentical in interface IClone
Parameters:
other - A reference to a com.esri.arcgis.system.IClone (in)
Returns:
The identical
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException
isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isDirty in interface IPersistStream
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException
load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
load in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws IOException,
                 AutomationException
save

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
save in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
fClearDirty - The fClearDirty (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws IOException,
                       AutomationException
getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getSizeMax in interface IPersistStream
Parameters:
pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws IOException,
                       AutomationException
getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getClassID in interface IPersist
Parameters:
pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws IOException,
                      AutomationException
Serializes an object to XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
serialize in interface IXMLSerialize
Parameters:
data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws IOException,
                        AutomationException
Deserializes an object from XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
deserialize in interface IXMLSerialize
Parameters:
data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException
Specified by:
writeExternal in interface Externalizable
Throws:
IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
Specified by:
readExternal in interface Externalizable
Throws:
IOException
ClassNotFoundException