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)
Visual Basic (Declaration) |
---|
Function GetEngineObjectValue ( _
propertyName As String _
) As IEngineObject |
Visual C++ |
---|
IEngineObject^ GetEngineObjectValue(
String^ propertyName
) |
JavaScript |
---|
function getEngineObjectValue(propertyName); |
Parameters
- propertyName
- Type: System..::.String
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.
Exception | Condition |
---|
FileNet.Api.Exception..::.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).
|