Jump to main content

##

# 1.2.5.4.2 SYS_DEBUG_Status Function

## C

    SYS_STATUS SYS_DEBUG_Status ( SYS_MODULE_OBJ object )

## Summary

Returns status of the specific instance of the debug service module.

## Description

This function returns the status of the specific debug service module instance.

## Precondition

The SYS_DEBUG_Initialize function should have been called before calling this function.

## Parameters

Param | Description
--- | ---
object | Debug module object handle, returned from SYS_DEBUG_Initialize

## Returns

SYS_STATUS_READY - Indicates that the module is running and ready to service requests. Any value greater than SYS_STATUS_READY is also a normal running state in which the module is ready to accept new operations.

SYS_STATUS_BUSY - Indicates that the module is busy with a previous system level operation.

SYS_STATUS_ERROR - Indicates that the module is in an error state. Any value less than SYS_STATUS_ERROR is also an error state.

SYS_STATUS_UNINITIALIZED - Indicates that the module has not been initialized.

## Example

    SYS_MODULE_OBJ object; // Returned from SYS_CONSOLE_Initialize
    SYS_STATUS debugStatus;

    debugStatus = SYS_DEBUG_Status (object);

    if (debugStatus == SYS_STATUS_READY)
    {
        // Debug service is initialized and ready to accept requests.
    }

## Remarks

None.