GetProjectProperties 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

ICommonStructureService.GetProjectProperties Method

Gets the current properties for a project.

Namespace:  Microsoft.TeamFoundation.Server
Assembly:  Microsoft.TeamFoundation (in Microsoft.TeamFoundation.dll)

'Declaration
Sub GetProjectProperties ( _
	projectUri As String, _
	<OutAttribute> ByRef name As String, _
	<OutAttribute> ByRef state As String, _
	<OutAttribute> ByRef templateId As Integer, _
	<OutAttribute> ByRef properties As ProjectProperty() _
)
'Usage
Dim instance As ICommonStructureService 
Dim projectUri As String 
Dim name As String 
Dim state As String 
Dim templateId As Integer 
Dim properties As ProjectProperty()

instance.GetProjectProperties(projectUri, _
	name, state, templateId, properties)

Parameters

projectUri
Type: System.String

URI of the project from which the structure is to be obtained

name
Type: System.String%

Name of the project

state
Type: System.String%

State of the project (New, WellFormed, orDeleting)

templateId
Type: System.Int32%

Identifier for the project template

properties
Type: Microsoft.TeamFoundation.Server.ProjectProperty()%

Array of ProjectProperty values for the project

The following example sets the project at myProjectUri with a ProjectState values of Deleting.

ICommonStructureService css = (ICommonStructureService)tfs.GetService(typeof(ICommonStructureService));

string projName;

string projState;

int templateId;

ProjectProperty[] projProperties;

css.GetProjectProperties(myProjectUri, out projName, out projState, out templateId, out projProperties);

css.UpdateProjectProperties(myProjectUri, ProjectState.Deleting.ToString(), projProperties);

Show:
© 2016 Microsoft