Failure Class

The Failure object contains much of the same information as an exception but is not derived from Exception and is now throwable.

Commands that operate on a collection of items, each of which may succeed or fail independently of the others will return an array of Failure objects representing the items that had trouble.

The Failure object also contains fields that describe the context in which the error occurred. A smart client may use these to decide about how to handle the error. Irrelevant information remains null and will not be sent as part of the SOAP reply.


Namespace:  Microsoft.TeamFoundation.VersionControl.Server
Assembly:  Microsoft.TeamFoundation.VersionControl.Server (in Microsoft.TeamFoundation.VersionControl.Server.dll)

public class Failure : ICacheable

The Failure type exposes the following members.

Public methodFailureCreates an empty failure. Used for marshaling.

Public propertyCodeShort unique string that describes the error. Usually the classname of the exception. Synonymous with SoapException.Code
Public propertyComputerNameError context information.
Public propertyIdentityNameError context information.
Public propertyItemIdThe item's ID. Used to retrieve file contents
Public propertyLocalItemError context information.
Public propertyMessageHuman readable message that describes the error. Synonymous with SoapException.Message
Public propertyRequestTypeType of change requested in the operation. Only set when PendChanges() is called
Public propertyResourceNameError context information.
Public propertyServerItemError context information.
Public propertySeverityIndicates the failure "type"
Public propertyWarningsWarning elements
Public propertyWorkspaceNameError context information.
Public propertyWorkspaceOwnerError context information.

Public methodEqualsDetermines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetCachedSize
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
© 2014 Microsoft