Show/Hide Toolbars

Therefore Programming Interface 3.0

Retrieves the document from the server, opens it in read-only mode and embeds the content files or not

 

Namespace: Therefore.API

 

Visual Basic

Public Overridable Function Retrieve ( _

  nDocNo As Integer, _

  strInbox As String, _

  pServer As TheServer, _

  bEmbedContentFiles As Boolean _

) As String

C#

public virtual string Retrieve (

  int nDocNo,

  string strInbox,

  TheServer pServer,

  bool bEmbedContentFiles 

)

 

Parameters

nDocNo

The document number.

 

strInbox

The destination directory.

 

pServer

A valid and connected TheServer Object.

 

bEmbedContentFiles

true

Content files are embeded in the .thex file.

false

Content files are not embeded in the .thex file.

 

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