company logo

CTX_Structure :: HideInstance - Hide instance

The function can be used in the structure context to exclude an instance from being selected in any property handle. Hidden instances will return NO when trying to locate such an instance using Get() or another function to locate the instance. Position() (or the ++ or -- operator) will skip hidden instances.

The state is typically set in the DBRead() handler. When resetting or changing the selection in the property handle the state is automatically reset. You may, however, reset the state explicitly using the ShowInstance() context function.

The function returns the "hidden" state as it was set before calling the function.

Return value:  Return value ( logical  )

The function returns YES when the question was answered positively. Otherwise it returns NO.

Implementation details

logical CTX_Structure  :: HideInstance (  )