GatedCheckinException Class

  • Article

Exception to indicate that a check-in was denied because of the gated check-in plugin.

Inheritance Hierarchy

System.Object
  System.Exception
    System.ApplicationException
      Microsoft.TeamFoundation.TeamFoundationServerException
        Microsoft.TeamFoundation.Framework.Client.TeamFoundationServiceException
          Microsoft.TeamFoundation.Framework.Client.EventException
            Microsoft.TeamFoundation.Framework.Client.ActionDeniedBySubscriberException
              Microsoft.TeamFoundation.VersionControl.Client.GatedCheckinException

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

Syntax

'Declaration
<SerializableAttribute> _
Public NotInheritable Class GatedCheckinException _
    Inherits ActionDeniedBySubscriberException

[SerializableAttribute]
public sealed class GatedCheckinException : ActionDeniedBySubscriberException

[SerializableAttribute]
public ref class GatedCheckinException sealed : public ActionDeniedBySubscriberException

[<Sealed>]
[<SerializableAttribute>]
type GatedCheckinException =  
    class 
        inherit ActionDeniedBySubscriberException 
    end

public final class GatedCheckinException extends ActionDeniedBySubscriberException

The GatedCheckinException type exposes the following members.

Properties

  Name Description
Public property AffectedBuildDefinitions Gets a collection of build definitions that blocked the check-in attempt. This property is always valid.
Public property BuildUri Gets the uniform resource identifier (URI) of the build that is queued for check-in. This property is valid when the SubCode is 3.
Public property CheckInContainsLocks Gets a flag that indicates whether the set of pending changes that is being checked in contains at least one pending change that has the Lock bit set. This property is not set for shelvesets.
Public property CheckInTicket Gets the check-in ticket that is provided by the server for submitting a CheckInShelveset build request.
Public property Data Gets the data associated with this exception, if any. (Inherited from TeamFoundationServerException.)
Public property HasOverridePermission Gets a flag that indicates whether the user that performed the check-in has the required permissions to override the gated check-in policy. This property is always valid.
Public property HelpLink Gets or sets a link to the help file associated with this exception. (Inherited from Exception.)
Public property HResult Gets or sets HRESULT, a coded numerical value that is assigned to a specific exception. (Inherited from Exception.)
Public property InnerException Gets the Exception instance that caused the current exception. (Inherited from Exception.)
Public property IsRemoteException Gets a flag describing whether this exception was thrown by the server and received by the client. (Inherited from TeamFoundationServerException.)
Public property Message Gets a message that describes the current exception. (Inherited from Exception.)
Public property OverridePermissionFailures Gets a read-only collection of team projects for which the caller is missing the 'Override check-in validation by build' permission. This property is valid when SubCode is 4.
Public property QueueId Gets the queue ID for the build that is queued for check-in. This property is valid when the SubCode is 3.
Public property ShelvesetName Gets the name of the shelveset. This property is valid when the SubCode is 1 or 3.
Public property Source Gets or sets the name of the application or the object that causes the error. (Inherited from Exception.)
Public property StackTrace Gets a string representation of the immediate frames on the call stack. (Inherited from Exception.)
Public property StatusCode Gets the error code that was provided by the subscriber. (Inherited from ActionDeniedBySubscriberException.)
Public property SubCode Gets the subcode for this exception.
Public property SubscriberName Gets the name of the subscriber that denied the action. (Inherited from ActionDeniedBySubscriberException.)
Public property SubscriberType Gets the type name of the subscriber that denied the action. (Inherited from ActionDeniedBySubscriberException.)
Public property TargetSite Gets the method that throws the current exception. (Inherited from Exception.)

Top

Methods

  Name Description
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public method GetBaseException When overridden in a derived class, returns the Exception that is the root cause of one or more subsequent exceptions. (Inherited from Exception.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetObjectData Security Critical. When overridden in a derived class, sets the SerializationInfo with information about the exception. (Inherited from Exception.)
Public method GetType Gets the runtime type of the current instance. (Inherited from Exception.)
Public method ToString Creates and returns a string representation of the current exception. (Inherited from Exception.)

Top

Thread Safety

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

See Also

Reference

Microsoft.TeamFoundation.VersionControl.Client Namespace