1.3.10.5 WDRV_PIC32MZW_RegDomainSet Function
C
WDRV_PIC32MZW_STATUS WDRV_PIC32MZW_RegDomainSet ( DRV_HANDLE handle, const char *pRegDomain, const WDRV_PIC32MZW_REGDOMAIN_CALLBACK pfRegDomCallback )
Summary
Attempts to set the current regulatory domain.
Description
Requests that the current regulatory domain is changed to the one specified.
Precondition
WDRV_PIC32MZW_Initialize should have been called. WDRV_PIC32MZW_Open should have been called to obtain a valid handle.
Parameters
| Param | Description |
|---|---|
| handle | Client handle obtained by a call to WDRV_PIC32MZW_Open. |
| pRegDomain | Pointer to a null-terminated string which should match the name of one of the domains defined in device flash memory. The length of the string can be maximum 6 characters. |
| pfRegDomCallback | Pointer to callback function to receive confirmation. |
Returns
WDRV_PIC32MZW_STATUS_OK - The request has been accepted.
WDRV_PIC32MZW_STATUS_NOT_OPEN - The driver instance is not open.
WDRV_PIC32MZW_STATUS_INVALID_ARG - The parameters were incorrect.
WDRV_PIC32MZW_STATUS_REQUEST_ERROR - The request to the PIC32MZW was rejected.
Remarks
If the requested regulatory domain is not found in the device flash, then the domain remains unchanged (even though the return value is STATUS_OK). See also WDRV_PIC32MZW_RegDomainGet.