Programming Mechworks PDM > .NET API > MwPDMApi Namespace > Database Class > Database Methods

Retrieves unique id of parents/children documents related to the current one.

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

Syntax

Visual Basic
Public Function GetLinks ( _ uid As String, _ ByRef linkList As Object, _ linkType As Boolean, _ optionalQueryFilter As String _ ) As Integer

Visual Basic

Public Function GetLinks ( _

uid As String, _
ByRef linkList As Object, _
linkType As Boolean, _
optionalQueryFilter As String _
) As Integer

C#
public int GetLinks( string uid, ref Object linkList, bool linkType, string optionalQueryFilter )

public int GetLinks(

string uid,
ref Object linkList,
bool linkType,
string optionalQueryFilter
)

Visual C++
public: int GetLinks( String^ uid, Object^% linkList, bool linkType, String^ optionalQueryFilter )

Visual C++

public:

int GetLinks(
String^ uid,
Object^% linkList,
bool linkType,
String^ optionalQueryFilter
)

JavaScript
function getLinks(uid, linkList, linkType, optionalQueryFilter);

Parameters

uid

Type: System.String
unique id of the document

linkList

Type: System.Object
Output. The array containing the unique ids of the documents found.

linkType

Type: System.Boolean
if TRUE look for parents, otherwise for children

optionalQueryFilter

Type: System.String
optional filter to apply in the search. It must be in sql standard syntax.

Return Value

number of linked documents found

Remarks