Assembly: BlueCieloECM.InnoCielo.Meridian (in BlueCieloECM.InnoCielo.Meridian.dll) Version: 1.4.0.0 (1.4.40.0)
Syntax
C# |
---|
public BCTableView GetUserPrivileges( string userName, string enclosureID, bool includeDocType ) |
Visual Basic |
---|
Public Function GetUserPrivileges ( _ userName As String, _ enclosureID As String, _ includeDocType As Boolean _ ) As BCTableView |
Visual C++ |
---|
public: BCTableView^ GetUserPrivileges( String^ userName, String^ enclosureID, bool includeDocType ) |
Parameters
- userName
- Type: System..::..String
The name of the user. If nullNothingnullptra null reference (Nothing in Visual Basic) or an empty string, the current user is used.
- enclosureID
- Type: System..::..String
The ID property value of an enclosure to get privileges from. If the specified object is not an enclosure, the server will find an active enclosure for it, taking into account the current context.
- includeDocType
- Type: System..::..Boolean
A value indicating whether to include document types privileges.
Return Value
All privileges for the specified user on the specified enclosure.Remarks
The function will return a tableview (variant grid) of all privileges that are available for the specified user.
The tableview will contain a number of columns equal to the number of privilege categories plus one. First column in the tableview will contain the ID property value of the object to which these privileges are applied (for object-specific privileges) and nullNothingnullptra null reference (Nothing in Visual Basic) for class-wide privileges. Other columns will contain a privileges bit mask for each privilege category.
If includeDocType is trueTruetruetrue (True in Visual Basic), the tableview will include a row for each document type. First column will contain ID property value of the document type and only the document type category column will be filled (the other ones will contain nullNothingnullptra null reference (Nothing in Visual Basic)).