Retrieves an object of the
class based on the specified domain and ID. 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 domain As IDomain, _ ByVal name As String, _ ByVal filter As PropertyFilter _ ) As IPEConnectionPoint |
C# |
---|
public static IPEConnectionPoint FetchInstance( IDomain domain, string name, PropertyFilter filter ) |
C++ |
---|
public: static IPEConnectionPoint FetchInstance( IDomain domain, String name, PropertyFilter filter ) |
J# |
---|
public static IPEConnectionPoint FetchInstance( IDomain domain, string name, PropertyFilter filter ) |
JScript |
---|
public static
function FetchInstance( domain : IDomain, name : String, filter : PropertyFilter ) : IPEConnectionPoint |
Parameters
- domain
- A
object referencing the FileNet P8 domain in which this instance is scoped.IDomain
- name
- The symbolic name of the class instance 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
An object of the requested type.