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

Removes the folder and all the associated documents

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

Syntax

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

Parameters

userId
Type: System..::.Int32
The unique id of the user.
groupId
Type: System..::.Int32
Id of a particular group.
isAdmin
Type: System..::.Boolean
Flag (True/False) indicating whether the user (whose userId, is passed as argument) is an admin or not.
folderId
Type: System..::.Int32
The id of the folder

Return Value

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

See Also