1. Home / Web Services API Version 7.5 / SetDocumentRetention

SetDocumentRetention

Sets the Retention Period of the specified document.

Syntax

Visual Basic (declaration) 
Public Function SetDocumentRetention( _ 
	ByVal AuthenticationTicket as String, _ 
	ByVal Path as String, _ 
	ByVal RetentionStatus as short, _ 
	ByVal RetainUntil as datetime) as XmlNode

C# (declaration) 
public XmlNode SetDocumentRetention( 
	string AuthenticationTicket,
	string Path,
	short RetentionStatus,
	datetime RetainUntil)

Parameters

AuthenticationTicket
    string infoRouter ticket
Path
    string The Path of a document
RetentionStatus
    short Specifies the type of retension (0=No Retension;1=Forever;2=Until Specied Date)
RetainUntil
    datetime Specifies the retention period of the document if RetensionStatus=2

Return Value

returns xml fragment.
<response success="true" error="">
if success attribute is "true", the retention status has been updated successfully.
if success attribute is "false", the error attribute indicates the encountered
error.

Remarks

The caller must have at least "Change" right on the document.

See Also