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

Deletes the record for a particular user corresponding to the folder identified by folderId in the database.

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

Syntax

C#
public DocumentStatus..::.DeleteFolderStatus DeleteFolderDB(
	int userId,
	bool isAdmin,
	int folderId,
	bool forceDelete
)
Visual Basic (Declaration)
Public Function DeleteFolderDB ( _
	userId As Integer, _
	isAdmin As Boolean, _
	folderId As Integer, _
	forceDelete As Boolean _
) As DocumentStatus..::.DeleteFolderStatus
Visual C++
public:
DocumentStatus..::.DeleteFolderStatus DeleteFolderDB(
	int userId, 
	bool isAdmin, 
	int folderId, 
	bool forceDelete
)

Parameters

userId
Type: System..::.Int32
The unique id of the user.
isAdmin
Type: System..::.Boolean
Flag (True/False) indicating whether the user corresponding to the user id (in the argument) is an admin or not?
folderId
Type: System..::.Int32
Id of the folder whose record has to be deleted in the database.
forceDelete
Type: System..::.Boolean
Flag (True/False) indicating that if Child folder and documents exist, Delete them as well. If this value False and Child documents/folders exist, an error is returned.

Return Value

Enumerated value DeleteFolderStatus indicating if the operation succeeded or failed.

See Also