company logo

CTX_Property :: SetReadOnly - Set read only

The function allows setting the instance selected in the property handle to read-only. This will prevent the data in the property handle from being updated, i.e. one cannot add or delete instances to collection properties or change attribute values for an attribute property. SetReadOnly(YES) will also mark all subordinated instances and their property handles as read-only. The indication is reset when calling SetReadOnly(NO). Resetting the read-only state works hierarchical as well until subordinated instances or property handles are found, which are explicitly set to read-only by the application, i.e. SetReadOnly(NO) will not reset read-only states explicitly set by the application.

Return value:  Success ( logical  )

Implementation details

logical CTX_Property  :: SetReadOnly ( logical readonly )
  • readonly - Read-only state

    The read-only state may be true (YES) or false (NO). True (YES) indicates read-only state for the context, false (NO) indicated no read-only state.