fsp_plms_GetComponentStatus()

Synopsis:

#include <fsp/plms.h>

fsp_ResultType fsp_plms_GetComponentStatus( fsp_plms_HandleType *plms_hdl,
                                            char *component_name,
                                            fsp_plms_ComponentStateType *status ); 

Arguments:

plms_hdl

The PLMS handle returned in fsp_plms_Connect().

component_name

The name of the component to get the status from. This is a NULL-terminated string.

status

The status of the component that will be returned by the PLMS.

Library:

libplms

Use the -l plms option to qcc to link against this library.

Description:

The fsp_plms_GetComponentStatus() returns the current status of the given component. The caller must have the plms/query ability to use this call.

Returns:

Returns valid status and FSP_PLMS_STATUS_EOK on success, or FSP_PLMS_STATUS_FAIL on error and sets errno.

Errors:

EINVAL

Invalid input parameters.

EBADMSG

The resource manager received an invalid or combined client message.

ENOSYS

The resource manager received a client message with an incorrect extended type.

Example:

fsp_plms_GetComponentStatus(plms_hdl, “sshd”, &status);