IQApiException Class |
Represents an exception generated by the ImageQuest API system.
Inheritance HierarchyNamespace: Informa.ImageQuest.API.Library
Assembly: Informa.ImageQuest.API.Library (in Informa.ImageQuest.API.Library.dll) Version: 14.3.0.0
SyntaxThe IQApiException type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | IQApiException |
Create a new API Exception with a default message.
|
| IQApiException(String) |
Create a new API Exception with a user-defined message.
|
 | IQApiException(SerializationInfo, StreamingContext) |
Create a new API Exception from a serialized data stream.
|
| IQApiException(String, Exception) |
Create a new API Exception with a user-defined message which wraps a lower-level exception.
|
Properties| Name | Description | |
|---|---|---|
 | Data | Gets a collection of key/value pairs that provide additional user-defined information about the exception. (Inherited from Exception.) |
| HelpLink | Gets or sets a link to the help file associated with this exception. (Inherited from Exception.) |
| HResult | Gets or sets HRESULT, a coded numerical value that is assigned to a specific exception. (Inherited from Exception.) |
| InnerException | Gets the Exception instance that caused the current exception. (Inherited from Exception.) |
| Message | Gets a message that describes the current exception. (Inherited from Exception.) |
| Source | Gets or sets the name of the application or the object that causes the error. (Inherited from Exception.) |
| StackTrace | Gets a string representation of the immediate frames on the call stack. (Inherited from Exception.) |
| TargetSite | Gets the method that throws the current exception. (Inherited from Exception.) |
Methods| Name | Description | |
|---|---|---|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetBaseException | When overridden in a derived class, returns the Exception that is the root cause of one or more subsequent exceptions. (Inherited from Exception.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetObjectData | When overridden in a derived class, sets the SerializationInfo with information about the exception. (Inherited from Exception.) |
| GetType | Gets the runtime type of the current instance. (Inherited from Exception.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ToString | Creates and returns a string representation of the current exception. (Inherited from Exception.) |
Events| Name | Description | |
|---|---|---|
 | SerializeObjectState | Occurs when an exception is serialized to create an exception state object that contains serialized data about the exception. (Inherited from Exception.) |
RemarksThis excpetion is thrown by the API layer whenever it detect invalid parameter or and unexpected or illegal operation from an API consumer. API consumer applications will receive this exception wrapped in whatever the appropriate proxy exception (e.g. SoapException or FaultException for .NET applications.
See Also