Returns the realm for the current user.
Namespace: FileNet.Api.Core
Assembly: FileNet.Api (in filenet.api.dll)
Syntax
Visual Basic (Declaration) |
---|
Public Shared Function FetchCurrent( _ ByVal connection As IConnection, _ ByVal filter As PropertyFilter _ ) As IRealm |
C# |
---|
public static IRealm FetchCurrent( IConnection connection, PropertyFilter filter ) |
C++ |
---|
public: static IRealm FetchCurrent( IConnection connection, PropertyFilter filter ) |
J# |
---|
public static IRealm FetchCurrent( IConnection connection, PropertyFilter filter ) |
JScript |
---|
public static
function FetchCurrent( connection : IConnection, filter : PropertyFilter ) : IRealm |
Parameters
- connection
- A
object for establishing the connection to the Content Engine server. You can optionally include a filter to control which properties to return with the object. If you pass inConnection
for thenull
parameter, this method returns values for all non-object properties and returns placeholders for all object-valued properties. For details, see the description of thefilter
parameter.filter
- filter
- A
object that represents information for controlling which property values (and with what level of detail and recursion) to return. IfPropertyFilter
, this method returns values for all non-object properties and returns placeholders for all object-valued properties (null
properties with a state ofPropertyEngineObject
orPropertyState.UNEVALUATED
); any subsequent attempts to access an object-valued property will cause an automatic round-trip to the server to fetch its value.PropertyState.REFERENCE
Return Value
The realm of which the current user is a part.