This documentation is archived and is not being maintained.

VersionControlServer.GetCheckinNoteDefinitions Method

When a user checks in changes into the server that is running Team Foundation Server, they can leave, in addition to a generic comment string, a series of named note fields. For instance, a user might type on the command line /notes:reviewer=Bob;testsite=Chicago when they check in their files. Team Foundation Server does not have hard-coded fields called reviewer or testsite but they are entered as named properties of this changeset. In general, the property names are not established by the user checking in files, but by company policy, so you can query later for all changesets where the testsite property was set to Chicago. This gives you the ability to extend the Team Foundation Server-provided fields associated with changesets. This method returns the field definitions for all the note fields in the specified Team Projects. A field definition shows the string (such as testsite in the above example), but also an item the definition is associated with, whether the field is required, and where the item should be displayed in the order that you choose.

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

public CheckinNoteFieldDefinition[] GetCheckinNoteDefinitions(
	TeamProject[] teamProjects


Type: Microsoft.TeamFoundation.VersionControl.Client.TeamProject[]

Shows a listed array of team projects for which you want to compare.

Return Value

Type: Microsoft.TeamFoundation.VersionControl.Client.CheckinNoteFieldDefinition[]
CheckinNoteFieldDefinition array that is a union of all the fields of the server items.