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

Deletes the record corresponding to the document identified by documentId in the database and returns the file name of that document.

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

Syntax

C#
public DocumentStatus..::.DocumentDeleteStatus DeleteDocumentDB(
	int documentId,
	int currentUserId,
	bool isCurrentUserAdmin
)
Visual Basic (Declaration)
Public Function DeleteDocumentDB ( _
	documentId As Integer, _
	currentUserId As Integer, _
	isCurrentUserAdmin As Boolean _
) As DocumentStatus..::.DocumentDeleteStatus
Visual C++
public:
DocumentStatus..::.DocumentDeleteStatus DeleteDocumentDB(
	int documentId, 
	int currentUserId, 
	bool isCurrentUserAdmin
)

Parameters

documentId
Type: System..::.Int32
Id of the document whose record has to be deleted in the database.
currentUserId
Type: System..::.Int32
Unique id of the current user
isCurrentUserAdmin
Type: System..::.Boolean
Is the current user an administrator

Return Value

Enumerated value DocumentDeleteStatus indicating if the operation succeeded or failed. OfficeClip.BusinessLayer.Desktop..::.DocumentStatus..::.DocumentDeleteStatus

See Also