GatedCheckinException Class

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
	AffectedBuildDefinitions	Gets a collection of build definitions that blocked the check-in attempt. This property is always valid.
	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.
	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.
	CheckInTicket	Gets the check-in ticket that is provided by the server for submitting a CheckInShelveset build request.
	Data	Gets the data associated with this exception, if any. (Inherited from TeamFoundationServerException.)
	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.
	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.)
	IsRemoteException	Gets a flag describing whether this exception was thrown by the server and received by the client. (Inherited from TeamFoundationServerException.)
	Message	Gets a message that describes the current exception. (Inherited from Exception.)
	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.
	QueueId	Gets the queue ID for the build that is queued for check-in. This property is valid when the SubCode is 3.
	RemoteExceptionCode	Gets the exception code if this is a remote exception and an exception code was provided by the server. (Inherited from TeamFoundationServerException.)
	ShelvesetName	Gets the name of the shelveset. This property is valid when the SubCode is 1 or 3.
	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.)
	StatusCode	Gets the error code that was provided by the subscriber. (Inherited from ActionDeniedBySubscriberException.)
	SubCode	Gets the subcode for this exception.
	SubscriberName	Gets the name of the subscriber that denied the action. (Inherited from ActionDeniedBySubscriberException.)
	SubscriberType	Gets the type name of the subscriber that denied the action. (Inherited from ActionDeniedBySubscriberException.)
	TargetSite	Gets the method that throws the current exception. (Inherited from Exception.)

Top

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 a hash function for a particular type. (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.)

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