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

Checks the document (or folder) set and make sure that the operation that is supposed to be done on this set is allowed. The output status is flagged on the datatable.--------------------------------------------------------

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

Syntax

C#
public DataTable CheckDocumentSets(
	string fids,
	string dids,
	bool isRecursive,
	bool isDeleteCheck,
	bool isSrcGroupFolder,
	ConfigureInfo session
)
Visual Basic (Declaration)
Public Function CheckDocumentSets ( _
	fids As String, _
	dids As String, _
	isRecursive As Boolean, _
	isDeleteCheck As Boolean, _
	isSrcGroupFolder As Boolean, _
	session As ConfigureInfo _
) As DataTable
Visual C++
public:
DataTable^ CheckDocumentSets(
	String^ fids, 
	String^ dids, 
	bool isRecursive, 
	bool isDeleteCheck, 
	bool isSrcGroupFolder, 
	ConfigureInfo^ session
)

Parameters

fids
Type: System..::.String
A list of all the folder ids as obtained from the screen.
dids
Type: System..::.String
A list of all the document ids as obtained from the screen.
isRecursive
Type: System..::.Boolean
Recurse the folder if true
isDeleteCheck
Type: System..::.Boolean
If the delete operation is checked.
isSrcGroupFolder
Type: System..::.Boolean
Flag (True/False) indicating whether the source of the ids is a group folder.
session
Type: OfficeClip.Utils..::.ConfigureInfo
The user session object

Return Value

The datatable having the following elements
  • docIdThe id of the document, -1 if it is not a document
  • folderIdThe id of the folder, -1 if it is not a folder
  • isErrorTrue if there is an error
  • docNameThe name of the document, empty if not a document
  • folderNameThe name of the folder, empty if it is not a folder
  • docKeyThe keyword associated with the document
  • docDescThe Description associated with the document
  • CommentsAny Comments, can be used to send back the error message

See Also