MwPDMApi Namespace > RemoteAccess Class > RemoteAccess Methods

Get documents from 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 Function GetFromBriefcaseV2 ( _ bcFilename As String, _ chosenProject As String, _ restoreMode As Integer, _ overwrite As Boolean, _ restorePath As String, _ restoreDBMode As Integer, _ restoreProjectsMode As Integer, _ okCreateWorkingSet As Boolean, _ silent As Boolean, _ autoCheckOut As Boolean, _ backupFolder As String, _ resetOwnerCompanyId As Boolean _ ) As Integer

Visual Basic

Public Function GetFromBriefcaseV2 ( _

bcFilename As String, _
chosenProject As String, _
restoreMode As Integer, _
overwrite As Boolean, _
restorePath As String, _
restoreDBMode As Integer, _
restoreProjectsMode As Integer, _
okCreateWorkingSet As Boolean, _
silent As Boolean, _
autoCheckOut As Boolean, _
backupFolder As String, _
resetOwnerCompanyId As Boolean _
) As Integer

C#
public int GetFromBriefcaseV2( string bcFilename, string chosenProject, int restoreMode, bool overwrite, string restorePath, int restoreDBMode, int restoreProjectsMode, bool okCreateWorkingSet, bool silent, bool autoCheckOut, string backupFolder, bool resetOwnerCompanyId )

public int GetFromBriefcaseV2(

string bcFilename,
string chosenProject,
int restoreMode,
bool overwrite,
string restorePath,
int restoreDBMode,
int restoreProjectsMode,
bool okCreateWorkingSet,
bool silent,
bool autoCheckOut,
string backupFolder,
bool resetOwnerCompanyId
)

Visual C++
public: int GetFromBriefcaseV2( String^ bcFilename, String^ chosenProject, int restoreMode, bool overwrite, String^ restorePath, int restoreDBMode, int restoreProjectsMode, bool okCreateWorkingSet, bool silent, bool autoCheckOut, String^ backupFolder, bool resetOwnerCompanyId )

Visual C++

public:

int GetFromBriefcaseV2(
String^ bcFilename,
String^ chosenProject,
int restoreMode,
bool overwrite,
String^ restorePath,
int restoreDBMode,
int restoreProjectsMode,
bool okCreateWorkingSet,
bool silent,
bool autoCheckOut,
String^ backupFolder,
bool resetOwnerCompanyId
)

JavaScript
function getFromBriefcaseV2(bcFilename, chosenProject, restoreMode, overwrite, restorePath, restoreDBMode, restoreProjectsMode, okCreateWorkingSet, silent, autoCheckOut, backupFolder, resetOwnerCompanyId);

Parameters

bcFilename

Type: System.String
the BriefCase file to retrieve from

chosenProject

Type: System.String
the project to restore documents in
This parameter depends on value 0 of parameter restoreProjectsMode

restoreMode

Type: System.Int32
Possible values are:
0: load all files in the same folder
1: load all files under a folder preserving their structure
this parameter depends on value 0 of the parameter restoreDBMode

overwrite

Type: System.Boolean
overwrites imported files

restorePath

Type: System.String
a folder to load files in.
This parameter depends on value 1 of parameter restoreMode

restoreDBMode

Type: System.Int32
0: unzip files only
1: unzip files and rebuild records and parent-child relations

restoreProjectsMode

Type: System.Int32
0: load documents in selected project
1: recreate project structure if not already existing
This parameter depends on value 1 of parameter restoreDBMode

okCreateWorkingSet

Type: System.Boolean
false: do not create a Working Set with loaded documents
true: Create a Working Set with loaded documents

silent

Type: System.Boolean
avoid asking confirmation

autoCheckOut

Type: System.Boolean
whether to automatically check out documents

backupFolder

Type: System.String
the folder to store backup files

resetOwnerCompanyId

Type: System.Boolean
whether to reset the owner company ID

Remarks

The return code has the following values

•0: no errors

•1: MDB not supported

•2: Root Directory must have a drive letter

•3: ZIP file does not exist

•4: Briefcase function needs DBWorks Enterprise

•5: Remote Access not activated

•6: Briefcase function can't be used when working with Remote Access Local Mode

•7: Briefcase has no files

•8: Error copying files in temporary SCHEMA folder

•9: Error starting Briefcase MDB database

•10: PARENT_CHILD structure in MDB is not compatible with PARENT_CHILD structure in target database

•11: Answered NO to question: Briefcase does not contain any record marked with your COMPANY_ID - Continue ?

•12: Briefcase has no records

•13: Button CANCEL has been pressed in the Document Selector form for selecting documents to be imported

•14: Answered NO to question: Files overwriting proprietary files have been discarded - Continue ?

•15: Answered NO to question: Importing the Briefcase will create duplicated IDs - Continue ?

•16: Error creating New file directory

•17: Answered NO to question: Local files are newer than Briefcase files - Do you want to overwrite them ?

•18: Failed to create backup copy ( if a backup folder is assigned ) of existing target files

•19: Answered ABORT to question: Error getting the Unique Id Of the record Of file - Retry / Abort ?

•20: Target file is now writeable

•21: Answered CANCEL to question: Target file is now writeable - Retry / Cancel ?

•22: Failed to copy briefcase file to target file

•23: Failed to created state dependent file copies when working in Local Checkout Mode

•24: Button CANCEL has been pressed in the Document Selector form for deleting the orphan records from target db

•25: Unable to open log file for file copy errors checking

•26: Different time stamps between briefcase file and main archive file

•27: Button CANCEL has been pressed while populating the orphan documents selector form

•30: Trying to extract data in the wrong format. Try GetFromBriefcase function

•99: Generic communication error