MwPDMApi Namespace > RemoteAccess Class > RemoteAccess Methods

Put a document in the BriefCase, version 2: no MS Access and no 32bit standalone needed.

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

Syntax

Visual Basic
Public Sub PutInBriefcaseV2 ( _ readableFileName As String, _ destinationCompanyId As String, _ drawingsMode As Integer, _ addStandard As Boolean, _ addGeneric As Boolean, _ addNonManaged As Boolean, _ autoCheckOut As Boolean, _ traverseMode As Boolean, _ avoidToModifyCheckedOutDocuments As Boolean, _ addForeignDocuments As Boolean, _ transferOwnerShip As Boolean, _ onlyProjects As Boolean _ )

Visual Basic

Public Sub PutInBriefcaseV2 ( _

readableFileName As String, _
destinationCompanyId As String, _
drawingsMode As Integer, _
addStandard As Boolean, _
addGeneric As Boolean, _
addNonManaged As Boolean, _
autoCheckOut As Boolean, _
traverseMode As Boolean, _
avoidToModifyCheckedOutDocuments As Boolean, _
addForeignDocuments As Boolean, _
transferOwnerShip As Boolean, _
onlyProjects As Boolean _
)

C#
public void PutInBriefcaseV2( string readableFileName, string destinationCompanyId, int drawingsMode, bool addStandard, bool addGeneric, bool addNonManaged, bool autoCheckOut, bool traverseMode, bool avoidToModifyCheckedOutDocuments, bool addForeignDocuments, bool transferOwnerShip, bool onlyProjects )

public void PutInBriefcaseV2(

string readableFileName,
string destinationCompanyId,
int drawingsMode,
bool addStandard,
bool addGeneric,
bool addNonManaged,
bool autoCheckOut,
bool traverseMode,
bool avoidToModifyCheckedOutDocuments,
bool addForeignDocuments,
bool transferOwnerShip,
bool onlyProjects
)

Visual C++
public: void PutInBriefcaseV2( String^ readableFileName, String^ destinationCompanyId, int drawingsMode, bool addStandard, bool addGeneric, bool addNonManaged, bool autoCheckOut, bool traverseMode, bool avoidToModifyCheckedOutDocuments, bool addForeignDocuments, bool transferOwnerShip, bool onlyProjects )

Visual C++

public:

void PutInBriefcaseV2(
String^ readableFileName,
String^ destinationCompanyId,
int drawingsMode,
bool addStandard,
bool addGeneric,
bool addNonManaged,
bool autoCheckOut,
bool traverseMode,
bool avoidToModifyCheckedOutDocuments,
bool addForeignDocuments,
bool transferOwnerShip,
bool onlyProjects
)

JavaScript
function putInBriefcaseV2(readableFileName, destinationCompanyId, drawingsMode, addStandard, addGeneric, addNonManaged, autoCheckOut, traverseMode, avoidToModifyCheckedOutDocuments, addForeignDocuments, transferOwnerShip, onlyProjects);

Parameters

readableFileName

Type: System.String
the full file name of the briefcase to put doc into

destinationCompanyId

Type: System.String
destination Company ID (according to what specified in DBCustomizer)

drawingsMode

Type: System.Int32
drawings mode (0: Do not add drawings, 1: Add all related drawings, 2: Add only drawings of documents to be modified)

addStandard

Type: System.Boolean
add standard parts (false: Do not add standard parts, true: Add standard parts)

addGeneric

Type: System.Boolean
add generic documents (false: Do not add generic documents, true: Add generic documents)

addNonManaged

Type: System.Boolean
add unmanaged components (false: Do not add unmanaged components, true: Add unmanaged components)

autoCheckOut

Type: System.Boolean
auto checkout mode (false: Do not set autocheckout, true: Set autocheckout mode)

traverseMode

Type: System.Boolean
traverse mode (false: Insert only the passed node, true: Insert also passed node children)

avoidToModifyCheckedOutDocuments

Type: System.Boolean
avoid modifying checked out documents (false: Let modify checkedout documents, true: Do not allow the destination company to modify checkedout documents)

addForeignDocuments

Type: System.Boolean
add foreign documents (false: Do not add foreign documents, true: Add foreign documents)

transferOwnerShip

Type: System.Boolean
transfer ownership (false: Do not allow to take ownership, true: Allows the destination company to take the full ownership of the documents received for modification)

onlyProjects

Type: System.Boolean
only projects (false: Insert every document, true: Insert only projects and their PARENT_CHILD relations)

Remarks

The option must be used with the Autocheckout Mode set to FALSE. When the option is checked, the following changes applies to the briefcase being written:

•The state BEING_MODIFIED ( Checked-out ) is transformed into state CHECKED_IN

•The OWNER_COMPANY_ID is always set to NULL

•The CHECKED_OUT_BY is always set to NULL