Logo
UNICENS V2.1.0-3491
User Manual and API Reference
Ucs_Return_t Ucs_Network_ForceNotAvailable ( Ucs_Inst_t self,
bool  force,
Ucs_StdResultCb_t  result_fptr 
)

Triggers the INIC to force the NotAvailable state.

Parameters
selfThe instance
forceIs true if the INIC shall force the network in NotAvailable state. If false the INIC shall no no longer force the network to NotAvailable state.
result_fptrOptional result callback
Returns
Possible return values are shown in the table below.
Value Description
UCS_RET_SUCCESS No error
UCS_RET_ERR_BUFFER_OVERFLOW No message buffer available
UCS_RET_ERR_API_LOCKED API is currently locked
UCS_RET_ERR_NOT_INITIALIZED UNICENS is not initialized