Export (0) Print
Expand All

Failure Class

Describes a failure.

System.Object
  Microsoft.TeamFoundation.VersionControl.Client.Failure

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

public sealed class Failure

The Failure type exposes the following members.

  NameDescription
Public propertyCodeGets the failure code.
Public propertyComputerNameGets the name of the computer that is associated with the failure.
Public propertyIdentityNameGets the identity that is associated with the failure.
Public propertyItemIdGets the item ID that is associated with the failure.
Public propertyLocalItemGets the local item that is associated with the failure.
Public propertyMessageGets the failure message.
Public propertyRequestTypeGets the request type that caused this failure.
Public propertyResourceNameGets the resource name that is associated with the failure.
Public propertyServerItemGets the server item that is associated with the failure.
Public propertySeverityGets the severity of the failure.
Public propertyVersionControlServerGets the version control server on which the failure occurred.
Public propertyWarningsGets an array of warnings that is associated with the failure.
Public propertyWorkspaceNameGets the workspace name that is associated with the failure.
Public propertyWorkspaceOwnerGets the workspace owner that is associated with the failure.
Top

  NameDescription
Public methodEqualsDetermines whether the specified object is equal to the current object. (Inherited from Object.)
Public methodGetFormattedMessageGets a user-readable message that describes this failure.
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodToStringCreates a user-readable string that describes the properties of a failure. (Overrides Object.ToString().)
Top

The Failure object contains much of the same information as an exception but is not derived from Exception and is not 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 make decisions about how to handle the error. Irrelevant info remains null and will not be sent as part of the soap reply.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show:
© 2014 Microsoft