16.20 - MSM_FreeAndClearWEventMembers/MSM_FreeAndClearOEvent Members - Teradata Ecosystem Manager

Teradata® Ecosystem Manager API Reference

Product
Teradata Ecosystem Manager
Release Number
16.20
Published
December 2020
Language
English (United States)
Last Update
2020-12-23
dita:mapPath
loa1512743917841.ditamap
dita:ditavalPath
ft:empty

Prototype:

Frees event members and clears them. This function should be called immediately before freeing pointer to event (in other words, before calling MSM_FreeWEvent/MSM_FreeOEvent). This function should be used to clear out status (member of MSM_WEvent/MSM_OEvent) in case it was non-zero and not explicitly cleared out before reusing the same pointer to MSM_WEvent/MSM_OEvent to send subsequent events.

Wide character:

error_code_t MSM_FreeAndClearWEventMembers(TM_Context* pCtx,MSM_WEvent* pWEvent)

Narrow character:

error_code_t MSM_FreeAndClearOEventMembers(TM_Context* pCtx,MSM_OEvent* pOEvent)

TM_Context* pCtx: Pointer to TM_Context returned by TM_Init

MSM_WEvent* pWEvent /MSM_OEvent* pOEvent: Pointer to MSM_WEvent/MSM_OEvent returned by MSM_CreateWEvent/ MSM_CreateOEvent

Value of error_code_t:

  • 0 (ERROR_OK) (success)
  • Non-zero value (failure)