1.1.6.7 WDRV_WINC_AssocPeerAddressGet

C

WDRV_WINC_STATUS WDRV_WINC_AssocPeerAddressGet
(
    WDRV_WINC_ASSOC_HANDLE assocHandle,
    WDRV_WINC_NETWORK_ADDRESS *const pPeerAddress
)

Description

Attempts to retrieve the network address of the peer device in the current association.

Precondition

WDRV_WINC_Initialize must have been called.

WDRV_WINC_Open must have been called to obtain a valid handle.

A peer device needs to be connected and associated.

Parameters

ParametersDescription
assocHandleAssociation handle.
pPeerAddressPointer to structure to receive the network address.

Returns

  • WDRV_WINC_STATUS_OK - pPeerAddress will contain the network address.

  • WDRV_WINC_STATUS_NOT_OPEN - The driver instance is not open.

  • WDRV_WINC_STATUS_INVALID_ARG - The parameters were incorrect.

  • WDRV_WINC_STATUS_REQUEST_ERROR - The request to the WINC was rejected or there is no current association.

  • WDRV_WINC_STATUS_RETRY_REQUEST - The network address is not available but it will be requested from the WINC.

  • WDRV_WINC_STATUS_NOT_CONNECTED - Not currently connected.

Remarks

If the network address is not currently known to the driver (stored within the WINC) a request will be sent to the WINC and the return status will be WDRV_WINC_STATUS_RETRY_REQUEST.