.NET Framework Class Library
BOM.GetBomAsArray Method

<< Click to Display Table of Contents >>

Navigation:  Programming Mechworks PDM > .NET API > MwPDMApi Namespace > BOM Class > BOM Methods >

.NET Framework Class Library
BOM.GetBomAsArray Method

Creates the Bom as an array of elements.

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

Syntax

Visual Basic

Public Function GetBomAsArray ( _

parameterFile As String, _
uid As String, _
ByRef ID_Col As Integer, _
ByRef UID_Col As Integer, _
ByRef QTY_Col As Integer, _
ByRef bomItemsRowCount As Integer, _
ByRef bomItemsColoumnCount As Integer, _
Optional revision As String = "" _
) As Object

C#

public Object GetBomAsArray(

string parameterFile,
string uid,
ref int ID_Col,
ref int UID_Col,
ref int QTY_Col,
ref int bomItemsRowCount,
ref int bomItemsColoumnCount,
string revision = ""
)

Visual C++

public:

Object^ GetBomAsArray(
String^ parameterFile,
String^ uid,
int% ID_Col,
int% UID_Col,
int% QTY_Col,
int% bomItemsRowCount,
int% bomItemsColoumnCount,
String^ revision = L""
)

JavaScript

function getBomAsArray(parameterFile, uid, ID_Col, UID_Col, QTY_Col, bomItemsRowCount, bomItemsColoumnCount, revision);

Parameters

parameterFile

Type: System.String
name of the parameter file in the par directory or full path to equivalent

uid

Type: System.String
unique_id of the assembly

ID_Col

Type: System.Int32
column of ID field. -1 if not found

UID_Col

Type: System.Int32
column of UID field. -1 if not found

QTY_Col

Type: System.Int32
column of QTY field. -1 if not found

bomItemsRowCount

Type: System.Int32
number of output rows (first row contains table description)

bomItemsColoumnCount

Type: System.Int32
number of element for each row

revision (Optional)

Type: System.String
Optional. Revision specification.

Return Value

Remarks

Output array is 1-dimensional. To generate a table, consider block of bomItemsColoumnCount (first row=0 is related to table description)

See Also

BOM Class

BOM Members

MwPDMApi Namespace