Retrieves an AddOn object based on the domain and ID specified. 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)

Syntax

Visual Basic (Declaration)
Public Shared Function FetchInstance( _ 
   ByVal domain As IDomain,  _ 
   ByVal name As String,  _ 
   ByVal filter As PropertyFilter _ 
) As IAddOn
C#
public static IAddOn FetchInstance(
   IDomain domain,
   string name,
   PropertyFilter filter
)
C++
public:
 static IAddOn FetchInstance(
   IDomain domain,
   String name,
   PropertyFilter filter
)
J#
public static IAddOn FetchInstance(
   IDomain domain,
   string name,
   PropertyFilter filter
)
JScript
public static  function FetchInstance(
   domain : IDomain,
   name : String,
   filter : PropertyFilter
) : IAddOn

Parameters

domain
The FileNet P8 domain for which this instance is scoped.
name
The symbolic name of the class instance to retrieve.
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 AddOn instance retrieved.

See Also