1.3.5.1.7 PRIME_API_Status Function

C

SYS_STATUS PRIME_API_Status(void)

Summary

Gets the current status of the PRIME Library.

Description

This routine gets the current status of the PRIME Library.

Precondition

The PRIME_API_Initialize should have been called before calling this function.

Parameters

None.

Returns

SYS_STATUS_READY: Indicates that the PRIME Library is ready and accepts requests for new operations.

SYS_STATUS_UNINITIALIZED: Indicates the PRIME Library is not initialized.

SYS_STATUS_ERROR: Indicates the PRIME Library is not initialized correctly.

SYS_STATUS_BUSY: Indicates the PRIME Library is initializing.

Example

PRIME_API_INIT init;

init.palIndex = PRIME_PAL_INDEX;
init.halApi = (HAL_API*)&halApi;
init.mngPlaneUsiPort = PRIME_MNG_PLANE_USI_INDEX;

PRIME_API_Initialize((&init);

if (PRIME_API_Status() == SYS_STATUS_READY)
{

}

Remarks

This routine is normally not called directly by an application. The PRIME application must use the function located in the PRIME API.