Status API

C8StatusInfo * C8GetManagerStatusInfo(const C8Char * i_manager_uri); – Purpose: Gets the status of a manager.

Parameters:

i_manager_uri: The manager URI.

Returns: The pointer to the status info object, or NULL if the function fails. The returned object must be freed with C8StatusInfoDestroy().

C8StatusInfo * C8GetManagerStatusInfoA(const C8Char * i_manager_uri, const C8UserCredentials *i_credentials); – Purpose: Gets the status of a manager. This version is used if the User Authentication feature limits the right to get status.

Parameters:

i_manager_uri: The manager URI.
i_credentials: The pointer to a structure containing the user's credentials (username and password).

Returns: The pointer to the status info object, or NULL if the function fails. The returned object must be freed with C8StatusInfoDestroy().

C8StatusInfo * C8GetWorkspaceStatusInfo(const C8Char * i_manager_uri, const C8Char * i_workspace_name, C8Bool i_need_ccx_info); – Purpose: Gets the status of a workspace.

Parameters:

i_manager_uri: The manager URI.
i_workspace_name: The workspace name.
i_need_ccx_info: Whether to include CCX information in the returned status object.

Returns: The pointer to the status info object, or NULL if the function fails. The returned object must be freed with C8StatusInfoDestroy().

C8StatusInfo * C8GetWorkspaceStatusInfoA(const C8Char * i_manager_uri, const C8Char * i_workspace_name, C8Bool i_need_ccx_info, const C8UserCredentials *i_credentials); – Purpose: Gets the status of a workspace.

This version is used if the User Authentication feature limits the right to get status.

Parameters:

i_manager_uri: The manager URI.
i_workspace_name: The workspace name.
i_need_ccx_info: Whether to include CCX information in the returned status object.
i_credentials: The pointer to a structure containing the user's credentials (username and password).

Returns: The pointer to the status info object, or NULL if the function fails. The returned object must be freed with C8StatusInfoDestroy().

C8StatusInfo * C8GetApplicationStatusInfo(const C8Char * i_manager_uri, const C8Char * i_workspace_name, const C8Char * i_app_name, C8Bool i_need_ccx_info); – Purpose: Gets the status of a CCL application.

Parameters:

i_manager_uri: The manager URI.
i_workspace_name: The workspace name.
i_app_name: The CCL application name.
i_need_ccx_info: Whether to include CCX information in the returned status object.

Returns: The pointer to the status info object, or NULL if the function fails. The returned object must be freed with C8StatusInfoDestroy().

C8StatusInfo * C8GetApplicationStatusInfoA(const C8Char * i_manager_uri, const C8Char * i_workspace_name, const C8Char * i_app_name, C8Bool i_need_ccx_info, const C8UserCredentials *i_credentials); – Purpose: Gets the status of a CCL application. This version is used if the User Authentication feature limits the right to get status.

Parameters:

i_manager_uri: The manager URI.
i_workspace_name: The workspace name.
i_app_name: The CCL application name.
i_need_ccx_info: Whether to include CCX information in the returned status object.
i_credentials: The pointer to a structure containing the user's credentials (username and password).

Returns: The pointer to the status info object, or NULL if the function fails. The returned object must be freed with C8StatusInfoDestroy().

void C8StatusInfoDestroy(C8StatusInfo * i_status); – Purpose: Destroys a status object.

Parameters:

i_status: The valid pointer to a status object.

Returns: Nothing.

C8Status C8StatusInfoGetTimestamp(const C8StatusInfo * i_status, C8Timestamp * o_ts); – Purpose: Returns the timestamp of the status info object.

Parameters:

i_status: The valid pointer to a status object.
o_ts: Location where the result is to be written.

Returns: C8_OK on success; C8_Fail otherwise.

C8Status C8StatusInfoGetMessage (const C8StatusInfo * i_status, const C8Char * i_grp_name, const C8Char * i_obj_name, const C8Char * i_msg_name, const C8Message ** o_msg); – Purpose: Gets a status message. The pointer to the message is valid while the pointer to the status is valid.

Parameters:

i_status: The valid pointer to a status object.
i_grp_name: The name of a group.
i_obj_name: The name of an object in a group.
i_msg_name: The name of a message in an object.
o_msg: Location where the result is to be written.

Returns: C8_OK on success; C8_Fail otherwise.

C8Status C8StatusInfoGetMessageByMessageIndex (const C8StatusInfo * i_status, const C8Char * i_grp_name, const C8Char * i_obj_name, C8UInt i_msg_ndx, const C8Message ** o_msg); – Purpose: Gets a status message. The pointer to the message is valid while the pointer to the status is valid.

Parameters:

i_status: The valid pointer to a status object.
i_grp_name: The name of a group.
i_obj_name: The name of an object in a group.
i_msg_ndx: The valid index of an object in a group (0-based).
o_msg: Location where the result is to be written.

Returns: C8_OK on success; C8_Fail otherwise.

C8Status C8StatusInfoGetMessageByObjectIndex (const C8StatusInfo * i_status, const C8Char * i_grp_name, C8UInt i_obj_ndx, const C8Char * i_msg_name, const C8Message ** o_msg); – Purpose: Gets a status message. The pointer to the message is valid while the pointer to the status is valid.

Parameters:

i_status: The valid pointer to a status object.
i_grp_name: The name of a group.
i_obj_ndx: The valid index of an object in a group (0-based).
i_msg_name: The name of a message in an object.
o_msg: Location where the result is to be written.

Returns: C8_OK on success; C8_Fail otherwise.

C8Status C8StatusInfoGetMessageByObjectAndMessageIndex (const C8StatusInfo * i_status, const C8Char * i_grp_name, C8UInt i_obj_ndx, C8UInt i_msg_ndx, const C8Message ** o_msg); – Purpose: Gets a status message. The pointer to the message is valid while the pointer to the status is valid.

Parameters:

i_status: The valid pointer to a status object.
i_grp_name: The name of a group.
i_obj_ndx: The valid index of an object in a group (0-based).
i_msg_ndx: The valid index of an object in a group (0-based).
o_msg: Location where the result is to be written.

Returns: C8_OK on success; C8_Fail otherwise.

C8Status C8StatusInfoGetMessageByGroupIndex (const C8StatusInfo * i_status, C8UInt i_grp_ndx, const C8Char * i_obj_name, const C8Char * i_msg_name, const C8Message ** o_msg); – Purpose: Gets a status message. The pointer to the message is valid while the pointer to the status is valid.

Parameters:

i_status: The valid pointer to a status object.
i_grp_ndx: The valid index of a group (0-based).
i_obj_name: The name of an object in a group.
i_msg_name: The name of a message in an object.
o_msg: Location where the result is to be written.

Returns: C8_OK on success; C8_Fail otherwise.

C8Status C8StatusInfoGetMessageByGroupAndMessageIndex (const C8StatusInfo * i_status, C8UInt i_grp_ndx, const C8Char * i_obj_name, C8UInt i_msg_ndx, const C8Message ** o_msg); – Purpose: Gets a status message. The pointer to the message is valid while the pointer to the status is valid.

Parameters:

i_status: The valid pointer to a status object.
i_grp_ndx: The valid index of a group (0-based).
i_obj_name: The name of an object in a group.
i_msg_ndx: The valid index of an object in a group (0-based).
o_msg: Location where the result is to be written.

Returns: C8_OK on success; C8_Fail otherwise.

C8Status C8StatusInfoGetMessageByGroupAndObjectIndex (const C8StatusInfo * i_status, C8UInt i_grp_ndx, C8UInt i_obj_ndx, const C8Char * i_msg_name, const C8Message ** o_msg); – Purpose: Gets a status message. The pointer to the message is valid while the pointer to the status is valid.

Parameters:

i_status: The valid pointer to a status object.
i_grp_ndx : The valid index of a group (0-based).
i_obj_ndx : The valid index of an object in a group (0-based).
i_msg_name: The name of a message in an object.
o_msg" Location where the result is to be written.

Returns: C8_OK on success; C8_Fail otherwise.

C8Status C8StatusInfoGetMessageByGroupAndObjectAndMessageIndex( const C8StatusInfo * i_status, C8UInt i_grp_ndx, C8UInt i_obj_ndx, C8UInt i_msg_ndx, const C8Message ** o_msg); – Purpose: Gets a status message. The pointer to the message is valid while the pointer to the status is valid.

Parameters:

i_status: The valid pointer to a status object.
i_grp_ndx: The valid index of a group (0-based).
i_obj_ndx: The valid index of an object in a group (0-based).
i_msg_ndx: The valid index of an object in a group (0-based).
o_msg " Location where the result is to be written.

Returns: C8_OK on success; C8_Fail otherwise.

C8Status C8StatusInfoHasMessage(const C8StatusInfo * i_status, const C8Char * i_grp_name, const C8Char * i_obj_name, const C8Char * i_msg_name, C8Bool* o_res); – Purpose: Checks whether the status info object contains a message.

Parameters:

i_status: The valid pointer to a status object.
i_grp_name: The name of a group.
i_obj_name: The name of an object in a group.
i_msg_name: The name of a message in an object.
o_res: Location where the result is to be written.

Returns: C8_OK on success; C8_Fail otherwise.

C8Status C8StatusInfoHasMessageByMessageIndex (const C8StatusInfo * i_status, const C8Char * i_grp_name, const C8Char * i_obj_name, C8UInt i_msg_ndx, C8Bool* o_res); – Purpose: Checks whether the status info object contains a message.

Parameters:

i_status: The valid pointer to a status object.
i_grp_name: The name of a group.
i_obj_name: The name of an object in a group.
i_msg_ndx: The valid index of an object in a group (0-based).
o_res: Location where the result is to be written.

Returns: C8_OK on success; C8_Fail otherwise.

C8Status C8StatusInfoHasMessageByObjectIndex (const C8StatusInfo * i_status, const C8Char * i_grp_name, C8UInt i_obj_ndx, const C8Char * i_msg_name, C8Bool* o_res); – Purpose: Checks whether the status info object contains a message.

Parameters:

i_status: The valid pointer to a status object.
i_grp_name: The name of a group.
i_obj_ndx: The valid index of an object in a group (0-based).
i_msg_name: The name of a message in an object.
o_re: Location where the result is to be written.

Returns: C8_OK on success; C8_Fail otherwise.y

C8Status C8StatusInfoHasMessageByObjectAndMessageIndex (const C8StatusInfo * i_status, const C8Char * i_grp_name, C8UInt i_obj_ndx, C8UInt i_msg_ndx, C8Bool* o_res); – Purpose: Checks whether the status info object contains a message.

Parameters:

i_status: The valid pointer to a status object.
i_grp_name: The name of a group.
i_obj_ndx: The valid index of an object in a group (0-based).
i_msg_ndx: The valid index of an object in a group (0-based).
o_res: Location where the result is to be written.

Returns: C8_OK on success; C8_Fail otherwise.

C8Status C8StatusInfoHasMessageByGroupIndex (const C8StatusInfo * i_status, C8UInt i_grp_ndx, const C8Char * i_obj_name, const C8Char * i_msg_name, C8Bool* o_res); – Purpose: Checks whether the status info object contains a message.

Parameters:

i_status: The valid pointer to a status object.
i_grp_ndx: The valid index of a group (0-based).
i_obj_name: The name of an object in a group.
i_msg_name: The name of a message in an object.
o_res: Location where the result is to be written.

Returns: C8_OK on success; C8_Fail otherwise.

C8Status C8StatusInfoHasMessageByGroupAndMessageIndex (const C8StatusInfo * i_status, C8UInt i_grp_ndx, const C8Char * i_obj_name, C8UInt i_msg_ndx, C8Bool* o_res); – Purpose: Checks whether the status info object contains a message.

Parameters:

i_status: The valid pointer to a status object.
i_grp_ndx: The valid index of a group (0-based).
i_obj_name: The name of an object in a group.
i_msg_ndx: The valid index of an object in a group (0-based).
o_res: Location where the result is to be written.

Returns:C8_OK on success; C8_Fail otherwise.

C8Status C8StatusInfoHasMessageByGroupAndObjectIndex (const C8StatusInfo * i_status, C8UInt i_grp_ndx, C8UInt i_obj_ndx, const C8Char * i_msg_name, C8Bool* o_res); – Purpose: Checks whether the status info object contains a message.

Parameters:

i_status: The valid pointer to a status object.
i_grp_ndx: The valid index of a group (0-based).
i_obj_ndx: The valid index of an object in a group (0-based).
i_msg_name: The name of a message in an object.
o_res: Location where the result is to be written.

Returns: C8_OK on success; C8_Fail otherwise.

C8Status C8StatusInfoHasMessageByGroupAndObjectAndMessageIndex(const C8StatusInfo * i_status, C8UInt i_grp_ndx, C8UInt i_obj_ndx, C8UInt i_msg_ndx, C8Bool* o_res); – Purpose: Checks whether the status info object contains a message.

Parameters:

i_status: The valid pointer to a status object.
i_grp_ndx: The valid index of a group (0-based).
i_obj_ndx: The valid index of an object in a group (0-based).
i_msg_ndx: The valid index of an object in a group (0-based).
o_res: Location where the result is to be written.

Returns: C8_OK on success; C8_Fail otherwise.

C8Status C8StatusInfoGetValue (const C8StatusInfo * i_status, const C8Char * i_grp_name, const C8Char * i_obj_name, const C8Char * i_msg_name, const C8Char ** o_val); – Purpose: Get a string value of the message. The returned pointer is valid while the pointer to the status info object remains valid.

Parameters:

i_status: The valid pointer to a status object.
i_grp_name: The name of a group.
i_obj_name: The name of an object in a group.
i_msg_name: The name of a message in an object.
o_val: Location where the result is to be written.

Returns: C8_OK on success; C8_Fail otherwise.

C8Status C8StatusInfoGetValueByMessageIndex (const C8StatusInfo * i_status, const C8Char * i_grp_name, const C8Char * i_obj_name, C8UInt i_msg_ndx, const C8Char ** o_val); – Purpose: Get a string value of the message. The returned pointer is valid while the pointer to the status info object remains valid.

Parameters:

i_status: The valid pointer to a status object.
i_grp_name: The name of a group.
i_obj_name: The name of an object in a group.
i_msg_ndx: The valid index of an object in a group (0-based).
o_val: Location where the result is to be written.

Returns: C8_OK on success; C8_Fail otherwise.

C8Status C8StatusInfoGetValueByObjectIndex (const C8StatusInfo * i_status, const C8Char * i_grp_name, C8UInt i_obj_ndx, const C8Char * i_msg_name, const C8Char ** o_val); – Purpose: Get a string value of the message. The returned pointer is valid while the pointer to the status info object remains valid.

Parameters:

i_status: The valid pointer to a status object.
i_grp_name: The name of a group.
i_obj_ndx: The valid index of an object in a group (0-based).
i_msg_name: The name of a message in an object.
o_val: Location where the result is to be written.

Returns: C8_OK on success; C8_Fail otherwise.

C8Status C8StatusInfoGetValueByObjectAndMessageIndex (const C8StatusInfo * i_status, const C8Char * i_grp_name, C8UInt i_obj_ndx, C8UInt i_msg_ndx, const C8Char ** o_val); – Purpose: Get a string value of the message. The returned pointer is valid while the pointer to the status info object remains valid.

Parameters:

i_status: The valid pointer to a status object.
i_grp_name: The name of a group.
i_obj_ndx: The valid index of an object in a group (0-based).
i_msg_ndx: The valid index of an object in a group (0-based).
o_val: Location where the result is to be written.

Returns: C8_OK on success; C8_Fail otherwise.

C8Status C8StatusInfoGetValueByGroupIndex (const C8StatusInfo * i_status, C8UInt i_grp_ndx, const C8Char * i_obj_name, const C8Char * i_msg_name, const C8Char ** o_val); – Purpose: Get a string value of the message. The returned pointer is valid while the pointer to the status info object remains valid.

Parameters:

i_status: The valid pointer to a status object.
i_grp_ndx: The valid index of a group (0-based).
i_obj_name: The name of an object in a group.
i_msg_name: The name of a message in an object.
o_val: Location where the result is to be written.

Returns: C8_OK on success; C8_Fail otherwise.

C8Status C8StatusInfoGetValueByGroupAndMessageIndex (const C8StatusInfo * i_status, C8UInt i_grp_ndx, const C8Char * i_obj_name, C8UInt i_msg_ndx, const C8Char ** o_val); – Purpose: Get a string value of the message. The returned pointer is valid while the pointer to the status info object remains valid.

Parameters:

i_status: The valid pointer to a status object.
i_grp_ndx: The valid index of a group (0-based).
i_obj_name: The name of an object in a group.
i_msg_ndx: The valid index of an object in a group (0-based).
o_val: Location where the result is to be written.

Returns: C8_OK on success; C8_Fail otherwise.

C8Status C8StatusInfoGetValueByGroupAndObjectIndex (const C8StatusInfo * i_status, C8UInt i_grp_ndx, C8UInt i_obj_ndx, const C8Char * i_msg_name, const C8Char ** o_val); – Purpose: Get a string value of the message. The returned pointer is valid while the pointer to the status info object remains valid.

Parameters:

i_status: The valid pointer to a status object.
i_grp_ndx: The valid index of a group (0-based).
i_obj_ndx: The valid index of an object in a group (0-based).
i_msg_name: The name of a message in an object.
o_val: Location where the result is to be written.

Returns: C8_OK on success; C8_Fail otherwise.

C8Status C8StatusInfoGetValueByGroupAndObjectAndMessageIndex(const C8StatusInfo * i_status, C8UInt i_grp_ndx, C8UInt i_obj_ndx, C8UInt i_msg_ndx, const C8Char ** o_val); – Purpose: Get a string value of the message. The returned pointer is valid while the pointer to the status info object remains valid.

Parameters:

i_status: The valid pointer to a status object.
i_grp_ndx: The valid index of a group (0-based).
i_obj_ndx: The valid index of an object in a group (0-based).
i_msg_ndx: The valid index of an object in a group (0-based).
o_val: Location where the result is to be written.

Returns: C8_OK on success; C8_Fail otherwise.

C8Status C8StatusInfoGetGroupCount(const C8StatusInfo * i_status, C8UInt * o_cnt); – Purpose: Get the number of groups in the status info object.

Parameters:

i_status: The valid pointer to a status object.
o_cnt: Location where the result is to be written.

Returns: C8_OK on success; C8_Fail otherwise.

C8Status C8StatusInfoGetGroupName(const C8StatusInfo * i_status, C8UInt i_grp_ndx, const C8Char ** o_grp_name); – Purpose: Get the name of a group in the status object.

Parameters:

i_status: The valid pointer to a status object.
i_grp_ndx: The valid index of a group (0-based).
o_grp_name: Location where the result is to be written.

Returns: C8_OK on success; C8_Fail otherwise.

C8Status C8StatusInfoGetObjectCount (const C8StatusInfo * i_status, const C8Char * i_grp_name, C8UInt * o_cnt); – Purpose: Get the number of objects in a group.

Parameters:

i_status: The valid pointer to a status object.
i_grp_name: The name of a group.
o_cnt: Location where the result is to be written.

Returns: C8_OK on success; C8_Fail otherwise

C8Status C8StatusInfoGetObjectCountByGroupIndex(const C8StatusInfo * i_status, C8UInt i_grp_ndx, C8UInt * o_cnt); – Purpose: Get the number of objects in a group.

Parameters:

i_status: The valid pointer to a status object.
i_grp_ndx: The valid index of a group (0-based).
o_cnt: Location where the result is to be written.

Returns: C8_OK on success; C8_Fail otherwise.

C8Status C8StatusInfoGetObjectName (const C8StatusInfo * i_status, const C8Char * i_grp_name, C8UInt i_obj_ndx, const C8Char ** o_name); – Purpose: Get the name of an object in a group.

Parameters:

i_status: The valid pointer to a status object.
i_grp_name: The name of a group.
i_obj_ndx: The valid index of an object in a group (0-based).
o_name: Location where the result is to be written.

Returns: C8_OK on success; C8_Fail otherwise.

C8Status C8StatusInfoGetObjectNameByGroupIndex(const C8StatusInfo * i_status, C8UInt i_grp_ndx, C8UInt i_obj_ndx, const C8Char ** o_name); – Purpose: Get the name of an object in a group.

Parameters:

i_status: The valid pointer to a status object.
i_grp_ndx: The valid index of a group (0-based).
i_obj_ndx: The valid index of an object in a group (0-based).
o_name: Location where the result is to be written.

Returns: C8_OK on success; C8_Fail otherwise.

C8Status C8StatusInfoGetMessageCount (const C8StatusInfo * i_status, const C8Char * i_grp_name, const C8Char * i_obj_name, C8UInt * o_cnt); – Purpose: Get the number of messages in an object.

Parameters:

i_status: The valid pointer to a status object.
i_grp_name: The name of a group.
i_obj_name: The name of an object in a group.
o_cnt location: The location where the result is to be written.

Returns: C8_OK on success; C8_Fail otherwise.

C8Status C8StatusInfoGetMessageCountByObjectIndex (const C8StatusInfo * i_status, const C8Char * i_grp_name, C8UInt i_obj_ndx, C8UInt * o_cnt); – Purpose: Get the number of messages in an object.

Parameters:

i_status: The valid pointer to a status object.
i_grp_name: The name of a group.
i_obj_ndx: The valid index of an object in a group (0-based).
o_cnt: Location where the result is to be written.

Returns: C8_OK on success; C8_Fail otherwise.

C8Status C8StatusInfoGetMessageCountByGroupIndex (const C8StatusInfo * i_status, C8UInt i_grp_ndx, const C8Char * i_obj_name, C8UInt * o_cnt); – Purpose: Get the number of messages in an object.

Parameters:

i_status: The valid pointer to a status object.
i_grp_nd: The valid index of a group (0-based).
i_obj_name: The name of an object in a group.
o_cnt: Location where the result is to be written.

Returns: C8_OK on success; C8_Fail otherwise.

C8Status C8StatusInfoGetMessageCountByGroupAndObjectIndex(const C8StatusInfo * i_status, C8UInt i_grp_ndx, C8UInt i_obj_ndx, C8UInt * o_cnt); – Purpose: Get the number of messages in an object.

Parameters:

i_status: The valid pointer to a status object.
i_grp_ndx: The valid index of a group (0-based).
i_obj_ndx: The valid index of an object in a group (0-based).
o_cnt: Location where the result is to be written.

Returns: C8_OK on success; C8_Fail otherwise.

C8Status C8StatusInfoGetMessageName (const C8StatusInfo * i_status, const C8Char * i_grp_name, const C8Char * i_obj_name, C8UInt i_msg_ndx, const C8Char ** o_name); – Purpose: Get the name of a message.

Parameters:

i_status: The valid pointer to a status object.
i_grp_name: The name of a group.
i_obj_name: The name of an object in a group.
i_msg_ndx: The valid index of an object in a group (0-based).
o_name: Location where the result is to be written.

Returns C8_OK on success; C8_Fail otherwise.:

C8Status C8StatusInfoGetMessageNameByObjectIndex (const C8StatusInfo * i_status, const C8Char * i_grp_name, C8UInt i_obj_ndx, C8UInt i_msg_ndx, const C8Char ** o_name); – Purpose: Get the name of a message.

Parameters:

i_status: The valid pointer to a status object.
i_grp_name: The name of a group.
i_obj_ndx: The valid index of an object in a group (0-based).
i_msg_ndx: The valid index of an object in a group (0-based).
o_name: Location where the result is to be written.

Returns: C8_OK on success; C8_Fail otherwise.

C8Status C8StatusInfoGetMessageNameByGroupIndex (const C8StatusInfo * i_status, C8UInt i_grp_ndx, const C8Char * i_obj_name, C8UInt i_msg_ndx, const C8Char ** o_name); – Purpose: Get the name of a message.

Parameters:

i_status: The valid pointer to a status object.
i_grp_ndx: The valid index of a group (0-based).
i_obj_name: The name of an object in a group.
i_msg_ndx: The valid index of an object in a group (0-based).
o_name: Location where the result is to be written.

Returns: C8_OK on success; C8_Fail otherwise.

C8Status C8StatusInfoGetMessageNameByGroupAndObjectIndex(const C8StatusInfo * i_status, C8UInt i_grp_ndx, C8UInt i_obj_ndx, C8UInt i_msg_ndx, const C8Char ** o_name); – Purpose: Get the name of a message.

Parameters:

i_status: The valid pointer to a status object.
i_grp_ndx: The valid index of a group (0-based).
i_obj_ndx: The valid index of an object in a group (0-based).
i_msg_ndx: The valid index of an object in a group (0-based).
o_name: Location where the result is to be written.

Returns: C8_OK on success; C8_Fail otherwise.