adTempus API
ArcanaDevelopment.adTempus.Client Namespace / DataContext Class / GetSecurityRoles Method / GetSecurityRoles(Boolean) Method
Determines whether permissions are returned with the entities


In This Topic
    GetSecurityRoles(Boolean) Method
    In This Topic
    Gets all security roles
    Syntax
    'Declaration
     
    
    <NotNullAttribute()>
    Public Overloads Function GetSecurityRoles( _
       Optional ByVal includePermissions As Boolean _
    ) As SecurityRoleCollection
    [NotNull()]
    public SecurityRoleCollection GetSecurityRoles( 
       bool includePermissions
    )
    [NotNull()]
    public:
    SecurityRoleCollection^ GetSecurityRoles( 
       bool includePermissions
    ) 

    Parameters

    includePermissions
    Determines whether permissions are returned with the entities

    Return Value

    All security roles
    Remarks

    The caller must have permission to administer security on the adTempus server.

    By default includePermissions is false and this method does not return the permissions associated with the entities (to save processing overhead). This is appropriate if you just want to display the names of the entities. If you subsequently need the permission for an entity, calling SecurityEntity.GetPermissions will fetch the permissions from the server.

    If you know in advance that you will want the permissions for all of the returned objects, it is more efficient to set includePermissions to true to return them all in a single call.

    See Also