GetAllCheckinNoteFieldNames Method
Important This document may not represent best practices for current development, links to downloads and other resources may no longer be valid. Current recommended version can be found here. ArchiveDisclaimer

VersionControlServer.GetAllCheckinNoteFieldNames Method

When a user checks changes into the server that is running Team Foundation Server, he can leave, in addition to a generic comment string, a series of named note fields. For instance, a user might type at the command prompt /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, 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 a list of all the check-in note field names that have ever been used in this Team Foundation Server database. So if the above example had ever been executed on any changeset, the returned list would include the strings reviewer and testsite.

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

public string[] GetAllCheckinNoteFieldNames()

Return Value

Type: System.String[]
Returns a list of check-in note field names.

Show:
© 2016 Microsoft