Workspace.CheckIn Method (array<PendingChange , String)
Checks in the specified set of pending changes to the version-control repository.
Namespace: Microsoft.TeamFoundation.VersionControl.Client
Assembly: Microsoft.TeamFoundation.VersionControl.Client (in Microsoft.TeamFoundation.VersionControl.Client.dll)
Syntax
'Declaration
Public Function CheckIn ( _
changes As PendingChange(), _
comment As String _
) As Integer
public int CheckIn(
PendingChange[] changes,
string comment
)
public:
int CheckIn(
array<PendingChange^>^ changes,
String^ comment
)
member CheckIn :
changes:PendingChange[] *
comment:string -> int
public function CheckIn(
changes : PendingChange[],
comment : String
) : int
Parameters
changes
Type: array<Microsoft.TeamFoundation.VersionControl.Client.PendingChange[]The set of pending changes to check in. If you do not specify this parameter, all changes in the workspace are checked in.
comment
Type: System.StringThe comment to be associated with this check-in. May be null.
Return Value
Type: System.Int32
If successful, a positive changeset number for this check-in.
Exceptions
| Exception | Condition |
|---|---|
| VersionControlException | This workspace has been deleted. |
Remarks
Each check-in is an atomic operation. All changes are checked in, or none are. If the check-in is successful, this method returns a positive changeset number. If the set of pending changes for the check-in is null, the server tries to check in all changes in the workspace. However, this operation is not valid if any pending changes in the workspace are edits or adds, because content will not have been uploaded to the server.
For more information about how to use this method, see Extending Version Control.
.NET Framework Security
- Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.