Returns a PropertyState constant that specifies the type of value held by this Property object as it relates to a particular Content Engine property. Possible values are:
  • NO_VALUE: Indicates that a Content Engine property is either Null (if it has single cardinality) or refers to an empty collection (if it has list or enumeration cardinality).
  • REFERENCE: Indicates that this Property object holds an ObjectReference object that specifies a reference to the object returned by a Content Engine property.
  • RETRIEVAL_ERROR: Indicates that this Property object holds an EngineRuntimeException object representing an error has occurred during retrieval of a Content Engine property value.
  • UNEVALUATED: Indicates that a Content Engine property returns an object whose value has not yet been determined.
  • VALUE: Indicates that this Property object holds an object that specifies a valid value of a Content Engine property.

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

ToggleSyntax

Visual Basic (Declaration)
Function GetState As PropertyState
C#
PropertyState GetState()
Visual C++
PropertyState GetState()
JavaScript
function getState();

Return Value

A PropertyState constant.

ToggleSee Also