Retrieves an object of the Group class by the specified domain and symbolic name. This method always makes a round-trip to the server. You can optionally include a filter to control which properties to return with the object. If you pass in null for the filter parameter, this method returns values for all non-object properties and returns placeholders for all object-valued properties. For details, see the description of the filter parameter.


Namespace: FileNet.Api.Core
Assembly: FileNet.Api (in filenet.api.dll)

Syntax

Visual Basic (Declaration)
Public Shared Function FetchInstance( _ 
   ByVal connection As IConnection,  _ 
   ByVal name As String,  _ 
   ByVal filter As PropertyFilter _ 
) As IGroup
C#
public static IGroup FetchInstance(
   IConnection connection,
   string name,
   PropertyFilter filter
)
C++
public:
 static IGroup FetchInstance(
   IConnection connection,
   String name,
   PropertyFilter filter
)
J#
public static IGroup FetchInstance(
   IConnection connection,
   string name,
   PropertyFilter filter
)
JScript
public static  function FetchInstance(
   connection : IConnection,
   name : String,
   filter : PropertyFilter
) : IGroup

Parameters

connection
A Connection object for establishing the connection to the Content Engine server.
name
The name of the class instance to retrieve. Valid strings are the Id, the short name, or the distinguished name. If the authentication provider is Microsoft Active Directory, you can also specify the UPN.
filter
A PropertyFilter object that represents information for controlling which property values (and with what level of detail and recursion) to return. If null, this method returns values for all non-object properties and returns placeholders for all object-valued properties (PropertyEngineObject properties with a state of PropertyState.UNEVALUATED or PropertyState.REFERENCE); any subsequent attempts to access an object-valued property will cause an automatic round-trip to the server to fetch its value.

Return Value

An object of the requested type.

See Also