WCM_UpdateOption

C Specification


#include <nitroWiFi/wcm.h>

u32   WCM_UpdateOption( u32 option );
				

Description

This is a synchronous function that updates option items that configure precise operation during wireless access point auto-search and during connection with wireless access points. If no fixed value is set using this function, when the WCM_Init function is called, the default values from initialization will be used. Calls made before initialization will be ignored.

Arguments

option Specifies 32-bit option update settings in accordance with the option-setting format.

There are five categories of options and each category has its own update setting bit. The detailed settings for a category are updated only if the corresponding update setting bit in the argument is set to 1 when updating. In other words, if an argument of 0 is specified, settings for none of the categories will be updated.
The following constant definitions are defined by taking the logical OR of the update setting bits in each category and the detail settings. Multiple categories can be updated at one time by specifying the logical OR value of the constant definitions for each category.

Channel list to search during wireless access point auto-search

WCM_OPTION_CHANNEL_RDC Setting to auto-search channels 1, 7 and, 13.(default)
WCM_OPTION_CHANNEL_ALL Setting to auto-search all channels, from 1 though 13.
WCM_OPTION_CHANNEL_1 to WCM_OPTION_CHANNEL_13 Setting to auto-search channels individually, from 1 though 13. More than one channel can be specified by using a logical OR.

Indicates whether notification is sent after going through the channel list once during wireless access point auto-search

WCM_OPTION_ROUNDSCAN_IGNORE No notification after going through the channel list once.(default)
WCM_OPTION_ROUNDSCAN_NOTIFY After going through the channel list once, the callback function specified by WCM_StartupAsync function is called as notification type WCM_NOTIFY_SEARCH_AROUND.

Scan process type during wireless access point auto-search

WCM_OPTION_SCANTYPE_PASSIVE Passive scanning method. A passive scanning method that waits to receive beacons sent by wireless access points.
Note that beacons from some wireless access points may not include ESS-ID information.(default)
WCM_OPTION_SCANTYPE_ACTIVE Active scanning method. A scanning method that actively searches for communication partners by issuing probe requests for a response from wireless access points.
Note that some wireless access points may not respond to probe requests that do not include ESS-IDs.

802.11 authentication method used when connecting to wireless access point

WCM_OPTION_AUTH_OPENSYSTEM Open system authentication method.(default)
WCM_OPTION_AUTH_SHAREDKEY Shared key authentication method. Uses the data array and encryption method specified by the WCMWepDesc structure when WCM_ConnectAsync was called.

Power save method for DCF communication after connection with wireless access point

WCM_OPTION_POWER_SAVE A power conservation method that synchronizes the DCF data reception with the beacon transmission timing of the wireless access point. The interval between data receptions will depend on the beacon transmission interval of the wireless access point, but this method can minimize power consumption.(default)
WCM_OPTION_POWER_ACTIVE Full-time powering method. The interval between DCF data receptions does not depend on the interval between beacon transmissions, so this method is effective in minimizing data reception delays. But because it steadily supplies power to the wireless hardware, power consumption is higher.

Return Values

Returns the option setting value before the update. If called before initialization, returns 0.

See Also

WCM_Init, WCM_StartupAsync, WCM_BeginSearchAsync, WCM_ConnectAsync, WCM_SetChannelScanTime, WCMConfig

Revision History

07/22/2005 Initial version.