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

Check if the document can be inserted in the folder for a particular group.

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

Syntax

C#
public DocumentStatus..::.DocumentPreInsertStatus CheckPreInsert(
	int userId,
	bool isAdmin,
	int groupId,
	int folderId,
	HttpPostedFile postedFile,
	ref string retStr,
	int srcDocumentId,
	bool isMove
)
Visual Basic (Declaration)
Public Function CheckPreInsert ( _
	userId As Integer, _
	isAdmin As Boolean, _
	groupId As Integer, _
	folderId As Integer, _
	postedFile As HttpPostedFile, _
	ByRef retStr As String, _
	srcDocumentId As Integer, _
	isMove As Boolean _
) As DocumentStatus..::.DocumentPreInsertStatus
Visual C++
public:
DocumentStatus..::.DocumentPreInsertStatus CheckPreInsert(
	int userId, 
	bool isAdmin, 
	int groupId, 
	int folderId, 
	HttpPostedFile^ postedFile, 
	String^% retStr, 
	int srcDocumentId, 
	bool isMove
)

Parameters

userId
Type: System..::.Int32
The unique id of the user.
isAdmin
Type: System..::.Boolean
Flag (True/False) indicating whether the user (whose userId, is passed as argument) is an admin or not.
groupId
Type: System..::.Int32
Id of the group.
folderId
Type: System..::.Int32
The id of the folder where is document is to be inserted.
postedFile
Type: System.Web..::.HttpPostedFile
The posted file, if this is non-null then srcFolderId should be -1.
retStr
Type: System..::.String%
A meaningful return string depending on the error code
srcDocumentId
Type: System..::.Int32
The source document id which will need to be transferred, this can be used in lieu of postedFile, if this is used, postedFile should be passed as null. This variable is useful when you are moving or copying files.
isMove
Type: System..::.Boolean
Flag indicating whether it is a move or copy operation. This parameter is valid only if the srcDocumentId is a non empty string.

Return Value

Enumerated value DocumentPreInsertStatus indicating if the operation succeeded or failed.

See Also