Indicates whether an object's direct caller is in a specified role (either individually or as part of a group).
Applies To
Syntax
objectcontext.IsCallerInRole(role)
The objectcontext placeholder represents an object variable that evaluates to the ObjectContext associated with the current object.
Parameters
objectcontext
An object variable that represents the ObjectContext belonging to the current object.
role
A string expression that contains the name of the role in which to determine if the caller is acting.
Return Values
True
Either the caller is in the specified role, or security is not enabled.
False
The caller is not in the specified role.
Remarks
You use this method to determine whether the direct caller of the currently executing method is associated with a specific role. A role is a symbolic name that represents a user or group of users who have specific access permissions to all components in a given package. Developers define roles when they create a component, and roles are mapped to individual users or groups at deployment time.
IsCallerInRole only applies to the direct caller of the currently executing method. (The direct caller is the process calling into the current server process. It can be either a base client process or a server process.) IsCallerInRole doesn't apply to the process that initiated the call sequence from which the current method was called, or to any other callers in that sequence.
Because IsCallerInRole returns True when the object that invokes it is executing in a client's process, it's a good idea to call IsSecurityEnabled before calling IsCallerInRole. If security isn't enabled, IsCallerInRole won't return an accurate result.
See Also
Programmatic Security, Basic Security Methods, Secured Components