SOC_GetConfigError

C Specification

#include <nitroWiFi/soc.h>
#define SOC_IP_ERR_DHCP_TIMEOUT    -100
s32 SOC_GetConfigError ( SOCInterface* interface );

Arguments

interface The pointer to the SOCInterface that obtains the error code. This argument is included for compatibility issues, but it is ignored in actual use of the function.

Return Values

0 Successful.
SOC_IP_ERR_DHCP_TIMEOUT DHCP server not found.
SOC_IP_ERR_LINK_DOWN There is a broken link.

Note: Additional errors may be generated and returned in future library releases. Please treat all negative return values as general errors.

Description

Gets the host configuration error code. The error code is a sticky code and is not cleared until SOC_ClearConfigError() is called.

See Also

SOC_ClearConfigError

Revision History

12/12/2005 Modified Description.
9/13/2005 Initial version.