4.4.1  Tool Initialization and Finalization

Summary A tool’s implementation of ompt_start_tool returns a pointer to an ompt_start_tool_result_t structure, which contains pointers to the tool’s initialization and finalization callbacks as well as an ompt_data_t object for use by the tool.

Format

 
typedef struct ompt_start_tool_result_t { 
  ompt_initialize_t initialize; 
  ompt_finalize_t finalize; 
  ompt_data_t tool_data; 
} ompt_start_tool_result_t;
  

Restrictions Restrictions to the ompt_start_tool_result_t type are as follows:

• The initialize and finalize callback pointer values in an ompt_start_tool_result_t structure that ompt_start_tool returns must be non-null.

Cross References

• ompt_start_tool function, see Section 4.2.1.
• ompt_data_t type, see Section 4.4.4.4.
• ompt_initialize_t callback type, see Section 4.5.1.1.
• ompt_finalize_t callback type, see Section 4.5.1.2.