[This is preliminary documentation and is subject to change.]
Inserts a document in a folder
Namespace:
OfficeClip.DBLayer.DesktopAssembly: OfficeClip.DBLayer (in OfficeClip.DBLayer)
Version: 8.1.1.0
Syntax
C# |
---|
public int InsertFileAndDocument( int groupId, string postedFileName, Stream postedFileStream, int folderId, string documentKey, string documentDesc, string isPrivateFlag, int applicationId, int applicationSecondaryId, int id, string appsDescription, int userId, string level, string groupName, string userName, bool isChecked ) |
Visual Basic (Declaration) |
---|
Public Function InsertFileAndDocument ( _ groupId As Integer, _ postedFileName As String, _ postedFileStream As Stream, _ folderId As Integer, _ documentKey As String, _ documentDesc As String, _ isPrivateFlag As String, _ applicationId As Integer, _ applicationSecondaryId As Integer, _ id As Integer, _ appsDescription As String, _ userId As Integer, _ level As String, _ groupName As String, _ userName As String, _ isChecked As Boolean _ ) As Integer |
Visual C++ |
---|
public: int InsertFileAndDocument( int groupId, String^ postedFileName, Stream^ postedFileStream, int folderId, String^ documentKey, String^ documentDesc, String^ isPrivateFlag, int applicationId, int applicationSecondaryId, int id, String^ appsDescription, int userId, String^ level, String^ groupName, String^ userName, bool isChecked ) |
Parameters
- groupId
- Type: System..::.Int32
Id of the group for which the document is to be stored. If isPrivate is "Y", this parameter will be ignored.
- postedFileName
- Type: System..::.String
Name of the document being created.
- postedFileStream
- Type: System.IO..::.Stream
File stream of the content of the document.
- folderId
- Type: System..::.Int32
The id of the folder where the document is supposed to be inserted.
- documentKey
- Type: System..::.String
Key or keywords associated with a document which can be used while searching for a document.
- documentDesc
- Type: System..::.String
Description of the document.
- isPrivateFlag
- Type: System..::.String
Is the document private
- applicationId
- Type: System..::.Int32
Id of the application to which object belongs to which this document is attached.
- applicationSecondaryId
- Type: System..::.Int32
Secondary Id distinguishing between two different kinds of objects belonging to an application.
- id
- Type: System..::.Int32
Id of another OfficeClip object with which this document is attached.
- appsDescription
- Type: System..::.String
Description when this document is attached to an object of another application.
- userId
- Type: System..::.Int32
Id of the user to who is uploading the document.
- level
- Type: System..::.String
A string indicating what level deep is the folder in which document is being stored. Moreover, if this string is starting with "001", it indicates that the currently selected group's virtual folder be used in storing the document. String starting with "002" indicates that the currently logged in user's virtual folder will be used in storing the document. String starting with "003" indicates that the application's virtual folder will be used in storing the document. After 001 or 002 or 003 the set of next two digits tell the order in which the document will appear on the screen and evey next set of two digit signifies the level deep below the root older level, that particular document is residing.
- groupName
- Type: System..::.String
Name of the current group.
- userName
- Type: System..::.String
Name of the current user.
- isChecked
- Type: System..::.Boolean
Flag (True/False) indicating whether a new revision should be created.