Retrieves an object of the Document class as specified by a path and an 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 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)

ToggleSyntax

Visual Basic (Declaration)
Public Shared Function FetchInstance ( _
	os As IObjectStore, _
	path As String, _
	filter As PropertyFilter _
) As IDocument
C#
public static IDocument FetchInstance(
	IObjectStore os,
	string path,
	PropertyFilter filter
)
Visual C++
public:
static IDocument^ FetchInstance(
	IObjectStore^ os, 
	String^ path, 
	PropertyFilter^ filter
)
JavaScript
FileNet.Api.Core.Document.fetchInstance = function(os, path, filter);

Parameters

os
Type: FileNet.Api.Core..::.IObjectStore
The ObjectStore object in which this class instance is located.
path
Type: System..::.String
The path of the object to retrieve.
filter
Type: FileNet.Api.Property..::.PropertyFilter
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.

ToggleSee Also