Retrieves an object of the
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
for the
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
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
is scoped. For more information, see theClassDescription IScope interface description.
- classId
- The ID (GUID) of the requested class instance.
- 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 requested
object.