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

With the Remote Access Mode enabled, downloads the foreign document file with the assigned unique id.

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

Syntax

Visual Basic
Public Function Download ( _ docUid As String, _ Optional mode As DownloadType = DownloadType.DOWNLOAD, _ Optional okDownloadZipFile As Boolean = True _ ) As ShellResult

Visual Basic

Public Function Download ( _

docUid As String, _
Optional mode As DownloadType = DownloadType.DOWNLOAD, _
Optional okDownloadZipFile As Boolean = True _
) As ShellResult

C#
public ShellResult Download( string docUid, DownloadType mode = DownloadType.DOWNLOAD, bool okDownloadZipFile = true )

public ShellResult Download(

string docUid,
DownloadType mode = DownloadType.DOWNLOAD,
bool okDownloadZipFile = true
)

Visual C++
public: ShellResult^ Download( String^ docUid, DownloadType mode = DownloadType::DOWNLOAD, bool okDownloadZipFile = true )

Visual C++

public:

ShellResult^ Download(
String^ docUid,
DownloadType mode = DownloadType::DOWNLOAD,
bool okDownloadZipFile = true
)

JavaScript
function download(docUid, mode, okDownloadZipFile);

Parameters

docUid

Type: System.String
unique id of the document to download

mode (Optional)

Type: MwPDMApi.DownloadType
Optional. The type of download to perform

okDownloadZipFile (Optional)

Type: System.Boolean
Optional. TRUE all the zip files will be downloaded from the remote site, FALSE no file will be downloaded from the remote site

Return Value

Shell result object. Additional items available: "@OKDOWNLOAD", "@ERROR_CODE"

Remarks