company logo

CTX_Structure :: SetRefContext - Set reference context

The function allows setting a reference context as link in another context e.g. to link structure contexts in a copy process. Only one context can be set as reference context. Calling the function several times will overwrite the reference context each time the function is called. When passing NULL as reference context the reference context will be reset.

The reference context is set to source instance when copying instances by the system. This allows determining, whether a read or store event has been fired during a copy action. Especially initialize event handler should not work or should work differently when being called during a copy action.

The function should never be called from within an event structure context handler (especially, when creating or inserting instances), and the reference context should be set to NULL before any Add (Create or insert) or Copy action.

Return value:  Success ( logical  )

Implementation details

logical CTX_Structure  :: SetRefContext ( CTX_Structure *strctx )
  • strctx - Structure Context

    Structure context for a property handle.