Reference for Team Foundation Server SDK
ICommonStructureService..::.GetProjectProperties Method

Gets the current properties for a project.

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

Visual Basic (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() _
)
Visual Basic (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)
C#
void GetProjectProperties(
    string projectUri,
    out string name,
    out string state,
    out int templateId,
    out ProjectProperty[] properties
)
Visual C++
void GetProjectProperties(
    String^ projectUri, 
    [OutAttribute] String^% name, 
    [OutAttribute] String^% state, 
    [OutAttribute] int% templateId, 
    [OutAttribute] array<ProjectProperty^>^% properties
)
JScript
function GetProjectProperties(
    projectUri : String, 
    name : String, 
    state : String, 
    templateId : int, 
    properties : ProjectProperty[]
)

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: array<Microsoft.TeamFoundation.Server..::.ProjectProperty>[]()[]%
Array of ProjectProperty values for the project
Examples

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);

Permissions

See Also

Reference

Tags :


Page view tracker