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

Renames the documents of the document set

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

Syntax

C#
public DocumentStatus..::.RenameDocumentStatus RenameDocument(
	string name,
	int id,
	bool isFolder,
	int userId,
	int groupId
)
Visual Basic (Declaration)
Public Function RenameDocument ( _
	name As String, _
	id As Integer, _
	isFolder As Boolean, _
	userId As Integer, _
	groupId As Integer _
) As DocumentStatus..::.RenameDocumentStatus
Visual C++
public:
DocumentStatus..::.RenameDocumentStatus RenameDocument(
	String^ name, 
	int id, 
	bool isFolder, 
	int userId, 
	int groupId
)

Parameters

name
Type: System..::.String
The name of the document/folder being renamed.
id
Type: System..::.Int32
The unique id of the document/folder being renamed.
isFolder
Type: System..::.Boolean
Flag (True/False) indicating whether the document is a folder.
userId
Type: System..::.Int32
The unique id of the user whose document/folder is renamed.
groupId
Type: System..::.Int32
The unique id of the group whose document/folder is renamed.

Return Value

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

See Also