vmware::vapi::std::errors::Canceled Class Reference

The Canceled error indicates that the method canceled itself in response to an explicit request to do so. More...

Inherits vmware::vapi::std::errors::Error.

List of all members.

Public Member Functions
	Canceled (global::System.Collections.Generic.List< vmware.vapi.std.LocalizableMessage > messages, vmware.vapi.bindings.IStructure data)
	Creates a new instance of this type using the given arguments.
	Canceled ()
	Creates a default new instance.
override vmware.vapi.bindings.type.StructType	_GetType ()
override vmware.vapi.data.StructValue	_GetDataValue ()
override void	_Validate ()
override bool	_HasTypeNameOf< T > ()
override T	_ConvertTo< T > ()
override bool	Equals (object obj)
override int	GetHashCode ()
Properties
override string	Message [get]

---

Detailed Description

The Canceled error indicates that the method canceled itself in response to an explicit request to do so.

Methods being "canceled" for other reasons (for example the client connection was closed, a time out occured, or due to excessive resource consumption) should not report this error.

Examples:

• A user is monitoring the progress of the method in a GUI and sees that it is likely to take longer than he is willing to wait and clicks the cancel button.
• A user invokes the method using a command-line tool and decides that she didn't really want to invoke that method, and presses CTRL-c.

Counterexamples:

• The client's connection to the server was closed. Reporting an error is pointless since the client will not receive the error response because the connection has been closed.
• The request is taking longer than some amount of time. The TimedOut error would be reported if the time was specified as part of the input or is documented in the API contract.

---

Constructor & Destructor Documentation

vmware::vapi::std::errors::Canceled::Canceled	(	global::System.Collections.Generic.List< vmware.vapi.std.LocalizableMessage >	messages,
		vmware.vapi.bindings.IStructure	data
	)		[inline]

Creates a new instance of this type using the given arguments.

vmware::vapi::std::errors::Canceled::Canceled

(

)

[inline]

Creates a default new instance.

---

Member Function Documentation

override T vmware::vapi::std::errors::Canceled::_ConvertTo< T >

(

)

[inline]

Reimplemented from vmware::vapi::std::errors::Error.

override vmware.vapi.data.StructValue vmware::vapi::std::errors::Canceled::_GetDataValue

(

)

[inline]

Reimplemented from vmware::vapi::std::errors::Error.

override vmware.vapi.bindings.type.StructType vmware::vapi::std::errors::Canceled::_GetType

(

)

[inline, virtual]

Reimplemented from vmware::vapi::std::errors::Error.

override bool vmware::vapi::std::errors::Canceled::_HasTypeNameOf< T >

(

)

[inline]

Reimplemented from vmware::vapi::std::errors::Error.

override void vmware::vapi::std::errors::Canceled::_Validate

(

)

[inline, virtual]

Reimplemented from vmware::vapi::std::errors::Error.

override bool vmware::vapi::std::errors::Canceled::Equals

(

object

obj

)

[inline]

Reimplemented from vmware::vapi::std::errors::Error.

override int vmware::vapi::std::errors::Canceled::GetHashCode

(

)

[inline]

Reimplemented from vmware::vapi::std::errors::Error.

---

Property Documentation

override string vmware::vapi::std::errors::Canceled::Message [get]

Reimplemented from vmware::vapi::std::errors::Error.

---

The documentation for this class was generated from the following file:

• Canceled.cs