5.5  OMPD Tool Interface Routines

This section defines the interface provided by the OMPD library to be used by the third-party tool.

Description of Return Codes All of the OMPD Tool Interface Routines must return function specific return codes or any of the following return codes:

• ompd_rc_stale_handle if a provided handle is stale;
• ompd_rc_bad_input if NULL is provided for any input argument unless otherwise specified;
• ompd_rc_callback if a callback returned an unexpected error, which leads to a failure of the query;
• ompd_rc_needs_state_tracking if the information cannot be provided while the debug-var is disabled;
• ompd_rc_ok on success; or
• ompd_rc_error for any other error.