Context management

Context management#

rocprofiler_status_t rocprofiler_create_context(rocprofiler_context_id_t *context_id)#

Create context.

Parameters:

context_id – [out] Context identifier

Returns:

rocprofiler_status_t

rocprofiler_status_t rocprofiler_start_context(rocprofiler_context_id_t context_id)#

Start context.

Parameters:

context_id – [in] Identifier for context to be activated

Returns:

rocprofiler_status_t

rocprofiler_status_t rocprofiler_stop_context(rocprofiler_context_id_t context_id)#

Stop context.

Parameters:

context_id – [in] Identifier for context to be deactivated

Returns:

rocprofiler_status_t

rocprofiler_status_t rocprofiler_context_is_active(rocprofiler_context_id_t context_id, int *status)#

Query whether context is currently active.

Parameters:

  • context_id – [in] Context identifier for the query

  • status – [out] If context is active, this will be a nonzero value

Return values:

  • ROCPROFILER_STATUS_SUCCESS – The input context id identified a registered context

  • ROCPROFILER_STATUS_ERROR_CONTEXT_NOT_FOUND – The input context id did not identify a registered context

Returns:

rocprofiler_status_t

rocprofiler_status_t rocprofiler_context_is_valid(rocprofiler_context_id_t context_id, int *status)#

Query whether the context is valid.

Parameters:

  • context_id – [in] Context identifier for the query

  • status – [out] If context is invalid, this will be a nonzero value

Returns:

rocprofiler_status_t

ROCPROFILER_CONTEXT_NONE#

The NULL Context handle.

Contents