.NET Framework Class Library
Document.GetDocProject Method

<< Click to Display Table of Contents >>

Navigation:  MwPDMApi Namespace > Document Class > Document Methods >

.NET Framework Class Library
Document.GetDocProject Method

Returns all the projects that a document belongs to.

Namespace: MwPDMApi
Assembly:  MwPDMApi (in MwPDMApi.dll) Version: 1.0.0.0 (1.0.0.0)

Syntax

Visual Basic

Public Function GetDocProject ( _

 docUid As String, _
 ByRef lastProjectUid As String, _
 ByRef number_of_projects As Integer, _
 ByRef projectsIdArray As Object _
As String

C#

public string GetDocProject(

 string docUid,
 ref string lastProjectUid,
 ref int number_of_projects,
 ref Object projectsIdArray
)

Visual C++

public:

StringGetDocProject(
 StringdocUid,
 String^% lastProjectUid,
 intnumber_of_projects,
 Object^% projectsIdArray
)

JavaScript

function getDocProject(docUidlastProjectUidnumber_of_projectsprojectsIdArray);

Parameters

docUid

Type: System.String
document unique id

lastProjectUid

Type: System.String
Output. The unique id of the project; in case of more than one it contains the last one

number_of_projects

Type: System.Int32
Output. The number of projects found

projectsIdArray

Type: System.Object
Ouput. The array containing ids of projects found

Return Value

The function assumes the value of the last (if more than one) project id found.

Remarks

For compatibility reasons, the projectsIdArray output array will always contain an empty string as the first element.

The number_of_projects output parameter instead will always contain the exact number of projects found, without considering the extra empty element.
Consider using the [!:GetDocProjectsArray] method instead, which does not have this behavior.

See Also

Document Class

Document Members

MwPDMApi Namespace