Refreshes this object and retrieves from the server the object referenced by the object-valued property specified by the propertyName parameter and populates its properties according to the filter.

Namespace:  FileNet.Api.Core
Assembly:  FileNet.Api (in FileNet.Api.dll)

ToggleSyntax

Visual Basic (Declaration)
Function FetchProperty ( _
	propertyName As String, _
	filter As PropertyFilter _
) As IProperty
C#
IProperty FetchProperty(
	string propertyName,
	PropertyFilter filter
)
Visual C++
IProperty^ FetchProperty(
	String^ propertyName, 
	PropertyFilter^ filter
)
JavaScript
function fetchProperty(propertyName, filter);

Parameters

propertyName
Type: System..::.String
A String specifying the name of the object-valued property.
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

A Property object.

ToggleExceptions

ExceptionCondition
ExceptionCode..::.API_SAVE_BEFORE_REFRESH Thrown if you attempt to retrieve properties for a new object that has not yet been saved.
ExceptionCode..::.TRANSPORT_EXPECTED_ENGINEOBJECT_RESPONSE Thrown if the property specified by the propertyName parameter does not return an object.

ToggleSee Also