[This is preliminary documentation and is subject to change.]

Returns the history of all the operations performed on the document.

Namespace:  OfficeClip.DBLayer.Desktop
Assembly:  OfficeClip.DBLayer (in OfficeClip.DBLayer)
Version: 8.1.1.0

Syntax

C#
public SqlDataReader GetHistory(
	int documentId
)
Visual Basic (Declaration)
Public Function GetHistory ( _
	documentId As Integer _
) As SqlDataReader
Visual C++
public:
SqlDataReader^ GetHistory(
	int documentId
)

Parameters

documentId
Type: System..::.Int32
Id of the document for which the history has to be returned.

Return Value

SqlDataReader containing all the information related to the history of a particular document. The SqlDataReader consists of the following columns.
  • activityId (System.Int32) Id indicating the type of operation that was perfomed on the document. 1 = Lock 2 = Update & Unlock 3 = Unlock 4 = Rename 5 = View/Download 6 = Move 7 = Copy 8 = Upload 9 = Lock & Download
  • activityTimestamp (System.DateTime) Date and Time when the particular operation was performed on the document.
  • name (System.String) Name of the user who performed the operation on the document.
  • emailAddress (System.String) Email Address of the user who performed the operation on the document.

Remarks

Make sure to Close the SqlDataReader after the use otherwise it will leave and connection open (till garbage collector releases the Data Reader). If not closed explicitly, the .Net framework might hang and slow down because of the number of open connections Limit might be reached.

See Also