ProjectsCheckout Method

Article
09/12/2006

Description

Checks out projects to the user, from Microsoft Office Project Server 2003.

Syntax

<Request>
   <ProjectsCheckout>
      <Project>
         <ProjectType></ProjectType>
         <ProjectID></ProjectID>
         <ProjectName></ProjectName>
      </Project>
   </ProjectsCheckout>
</Request>

Parameters

ProjectType

Optional. Valid values for ProjectType are as follows; the PDS ignores any other values:

Type	Description
0	Regular project (default)
1	Project template
2	Global template
3	Resource global

If ProjectType is 2 or 3, the PDS ignores ProjectID and ProjectName, and checks out the global template or resource global.

ProjectID* or *ProjectName

Optional. The PDS checks out the specified project ID or project name. Either ProjectID or ProjectName is required if ProjectType is 0 or 1. If ProjectID is specified, the PDS ignores ProjectName.

ProjectName is the project name as stored in the PROJ_NAME field of the MSP_PROJECTS table (the concatenation of the project identifier and the version name, separated by a period).

Return Value

If all requested project checkouts are successful, the method returns a successful HRESULT and STATUS. However, if one of the requested project checkouts fails, they all fail, and the return includes each project that failed and an error code.

<Reply>
   <HRESULT></HRESULT>
   <STATUS></STATUS>
   <UserName></UserName>
</Reply>

Remarks

The PDS checks Project Server security for the currently logged-on user and determines whether that user has sufficient permission to check out each requested project. The PDS also checks to make sure that the project is not currently checked out. If permissions are adequate, the PDS marks the project as checked out by the current user. ProjectsCheckout does not grant access to the project in the security table (see ProjectsAccess).

ProjectsCheckout accepts multiple sets of the Project parameters.

Share via