Show/Hide Toolbars

Therefore Programming Interface 3.0

Retrieves the document from the archive and opens it.

 

Namespace: Therefore.API

 

Visual Basic

Public Overridable Function Retrieve ( _

    nDocNo As Integer, _

  nVersionNo As Integer, _

    strInbox As String, _

  pServer As TheServer, _

    bReadOnly As Boolean _

) As String

C#

public virtual string Retrieve (

    int nDocNo,

    int nVersionNo,

    string strInbox,

    TheServer pServer,

    bool bReadOnly

)

 

Parameters

nDocNo

The document number.

 

nVersionNo

The version number. Pass 0 to get the latest version.

 

strInbox

The destination directory.

 

pServer

A valid and connected TheServer Object.

 

bReadOnly

true

The document is opened in read-only mode.

false

The document is opened for editing.

 

Return Value

Path and filename of the retrieved document.

 

 

Exception

Condition

Null Reference Argument

pServer parameter is a null reference / null pointer.

Invalid Server

pServer does not refer to a valid and connected Therefore™ server.

Number Not Found

nDocNo is not a valid document number.

Invalid Path

strInbox uses a path that is not valid on your system.

 

TheDocument class

TheDocument methods

TheServer class

 

© 2023 Therefore Corporation, all rights reserved.