void mi_tab_setuserdata(MI_AM_TABLE_DESC *tableDesc,
   void *userdata)

tableDesc

points to the table descriptor.

user_data

points to a data structure that the access method creates.

The access method stores state information from one purpose function so that another purpose function can use it.

Typically, an access method performs the preceding procedure in the am_open purpose function and deallocates the user-data memory in the am_close purpose function. To have the table descriptor retain the pointer to the user data as long as the table remains open, specify a memory duration of PER_STMT_EXEC or PER_STMT_PREP as Memory-Duration Options and Persistent User Data describe.

To retrieve the pointer from the table descriptor to access the table-state user data, call the mi_tab_userdata() function in any purpose function between am_open and am_close.

None

See the descriptions of:

• Function mi_tab_userdata()
• Purpose functions am_open and am_close
• DataBlade API functions for memory allocation and duration in Storing Data in Shared Memory