Show/Hide Toolbars

Therefore Programming Interface 3.0

Archive the current TheDocument with comments, using auto-append and reloading the document.

 

Namespace: Therefore.API

 

Visual Basic

Public Overridable Function Archive ( _

    pServer As TheServer, _

    nReplaceDocNo As Integer, _

  strCheckInComment As String, _

  bAllowUI As Boolean, _

  bReload As Boolean _

) As Integer

C#

public virtual int Archive (

  TheServer pServer,

    int nReplaceDocNo,

    string strCheckInComment,

  bool bAllowUI,

  bool bReload

)

 

Parameters

pServer

A valid and connected TheServer object.

 

nReplaceDocNo

The document number of the previous version of the document or 0 if this is a new document.

 

strCheckInComment

The Check-in comment.

 

bAllowUI

Set if user interface is allowed.

 

bReload

If true the document is reloaded from the server. This is only necessary if the document is used afterwards.

Set to false to boost performance.

 

Return Value

The document number of the new document.

 

Exception

Condition

Null Reference Argument

pServer is a null reference / null pointer.

Invalid Server

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

Document Not Open

The document was retrieved in read-only mode.

Category Undefined

The CtgryNo property of the document's IndexData does not refer to a valid category.

 

TheDocument class

TheDocument methods

TheServer class