Retrieves a
object using the specified path from the specified object store. 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 details, 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 os As IObjectStore, _ ByVal path As String, _ ByVal filter As PropertyFilter _ ) As ICustomObject |
C# |
---|
public static ICustomObject FetchInstance( IObjectStore os, string path, PropertyFilter filter ) |
C++ |
---|
public: static ICustomObject FetchInstance( IObjectStore os, String path, PropertyFilter filter ) |
J# |
---|
public static ICustomObject FetchInstance( IObjectStore os, string path, PropertyFilter filter ) |
JScript |
---|
public static
function FetchInstance( os : IObjectStore, path : String, filter : PropertyFilter ) : ICustomObject |
Parameters
- os
- The
object in which this class instance is located.ObjectStore
- path
- The full path name of the object to retrieve.
- 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.