Locates a PropertyEngineObject property by name in this Properties collection and returns the value it holds. If the property holds a reference object (Property.PropertyState = REFERENCE) or or is unevaluated (Property.PropertyState = UNEVALUATED), a round-trip is made to the server to fetch its value.


Namespace: FileNet.Api.Property
Assembly: FileNet.Api (in filenet.api.dll)

Syntax

Visual Basic (Declaration)
Function GetEngineObjectValue( _ 
   ByVal propertyName As String _ 
) As IEngineObject
C#
IEngineObject GetEngineObjectValue(
   string propertyName
)
C++
IEngineObject GetEngineObjectValue(
   String propertyName
) abstract 
J#
IEngineObject GetEngineObjectValue(
   string propertyName
)
JScript
function GetEngineObjectValue(
   propertyName : String
) : IEngineObject

Parameters

propertyName
A String specifying a property name.

Return Value

An EngineObject specifying the value of the property. If the property's value cannot be retrieved, an EngineRuntimeException object will be returned.

Exceptions

Exception TypeCondition
EngineRuntimeException Thrown if the property cannot be found in the collection, is not a PropertyEngineObject instance, or a retrieval error has occurred (Property.PropertyState = RETRIEVAL_ERROR).

See Also