Retrieves an object of the ClassDescription class by the specified identity. 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 more information, 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 scope As IScope,  _ 
   ByVal classId As Id,  _ 
   ByVal filter As PropertyFilter _ 
) As IClassDescription
C#
public static IClassDescription FetchInstance(
   IScope scope,
   Id classId,
   PropertyFilter filter
)
C++
public:
 static IClassDescription FetchInstance(
   IScope scope,
   Id classId,
   PropertyFilter filter
)
J#
public static IClassDescription FetchInstance(
   IScope scope,
   Id classId,
   PropertyFilter filter
)
JScript
public static  function FetchInstance(
   scope : IScope,
   classId : Id,
   filter : PropertyFilter
) : IClassDescription

Parameters

scope
The object to which this ClassDescription is scoped. For more information, see the IScope interface description.
classId
The ID (GUID) of the requested class instance.
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

The requested ClassDescription object.

See Also