API Guide Home (Online version only) |

# PalmWPPI.h File Reference

## Detailed Description

This is the API for Wi-Fi panel plug-ins (WPPIs).

Version:
  1.0

Date:
  05/16/2003

The Wi-Fi panel allows the user to manage their network profiles. Each profile includes a plugin, an authentication method, and a cookie used to identify the user's credentials. Each plugin provides support for one or more authentication methods; e.g., LEAP, PEAP, etc. A WPPI provides access to the user interface of an 802.1x client.

Definition in file PalmWPPI.h.

Go to the source code of this file.

## Data Structures

- struct WiFiAuthenticationMethodType
- struct SysWPPILaunchCmdGetAuthenticationMethodsType
- struct SysWPPILaunchCmdType
- struct SysWPPILaunchCmdGetDescriptionType
- struct SysWPPILaunchCmdPromptAndConfigureType
- struct SysWPPILaunchCmdErrorDialogType
- struct SysWPPILaunchCmdClearPWCache

## Defines

- #define sysFileTWiFiPanelPlugin 'Wppi'
- #define sysWPPILaunchCmdGetAuthenticationMethods sysAppLaunchCmdCustomBase
- #define kMaxWiFiAuthenticationMethodNameLength 31
- #define kMaxWiFiCredentialsLabelLength 31
- #define kMaxWiFiCredentialsSelectorTriggerLength 31
- #define sysWPPILaunchCmdOpen sysAppLaunchCmdCustomBase + 1
- #define sysWPPILaunchCmdClose sysAppLaunchCmdCustomBase + 2
- #define sysWPPILaunchCmdDialog sysAppLaunchCmdCustomBase + 3
- #define sysWPPILaunchCmdDelete sysAppLaunchCmdCustomBase + 4
- #define sysWPPILaunchCmdGetDescription sysAppLaunchCmdCustomBase + 5
- #define sysWPPILaunchCmdPromptAndConfigure (sysAppLaunchCmdCustomBase + 6)
- #define sysWPPILaunchCmdErrorDialog (sysAppLaunchCmdCustomBase + 7)
- #define sysWPPILaunchCmdClearPWCache (sysAppLaunchCmdCustomBase + 8)

## Define Documentation

#define kMaxWiFiAuthenticationMethodNameLength 31

Definition at line 57 of file PalmWPPI.h.

#define kMaxWiFiCredentialsLabelLength 31

Definition at line 102 of file PalmWPPI.h.

#define kMaxWiFiCredentialsSelectorTriggerLength 31

Definition at line 103 of file PalmWPPI.h.

#define sysFileTWiFiPanelPlugin 'Wppi'

database type for Wi-Fi panel plug-ins

Definition at line 32 of file PalmWPPI.h.

#define sysWPPILaunchCmdClearPWCache (sysAppLaunchCmdCustomBase + 8)

This is invoked to request a password cache clear. Removes temporary passwords from all accounts managed by the WPPI.

Definition at line 208 of file PalmWPPI.h.

#define sysWPPILaunchCmdClose sysAppLaunchCmdCustomBase + 2

If a non-zero cookie is passed in, we're editing an existing network with existing credentials. The WPPI should find the credentials in its database and put them in a temporary location. If a zero cookie is passed in, we're either creating a new network, editing an existing network that didn't previous have credentials, or switching authentication methods. The WPPI should set the credentialsLabel and credentialsSelectorTrigger. Typically, the credentialsLabel is "Credentials:" and the credentialsSelectorTrigger is "-Assigned-" or "-Unassigned-". Every call to sysWPPILaunchCmdOpen is matched with a call to sysWPPILaunchCmdClose.

Definition at line 128 of file PalmWPPI.h.

#define sysWPPILaunchCmdDelete sysAppLaunchCmdCustomBase + 4

The WPPI should open its dialog and allow the user to edit the credentials. It should read from the temporary location to initialize the username and password fields or other UI elements as appropriate. It should write to the temporary location when the user taps OK. It shouldn't access its database. Whether the user tapped Cancel should be stored in the cancel flag in the command parameter block. If the user taps OK and this changes the current credentials state (typically assigned/unassigned), the credentialsSelectorTrigger field should be updated by the WPPI. Note that the user may delete his credentials causing the state to change from assigned to unassigned.

Definition at line 147 of file PalmWPPI.h.

#define sysWPPILaunchCmdDialog sysAppLaunchCmdCustomBase + 3

If the save flag is set, the WPPI should write the user's credentials to its database. If the cookie is zero, it should create a new record and save its unique ID in the cookie field of the command parameter block. If the cookie is non-zero, it should overwrite the old record.

Definition at line 135 of file PalmWPPI.h.

#define sysWPPILaunchCmdErrorDialog (sysAppLaunchCmdCustomBase + 7)

This is invoked to put up an error dialog.

Definition at line 196 of file PalmWPPI.h.

#define sysWPPILaunchCmdGetAuthenticationMethods sysAppLaunchCmdCustomBase

Definition at line 55 of file PalmWPPI.h.

#define sysWPPILaunchCmdGetDescription sysAppLaunchCmdCustomBase + 5

Finally, the Wi-Fi Setup wizard displays a detailed description of the selected authentication method. To do this, it sublaunches the WPPI with the following launch code and command parameter block.

Definition at line 160 of file PalmWPPI.h.

#define sysWPPILaunchCmdOpen sysAppLaunchCmdCustomBase + 1

Definition at line 117 of file PalmWPPI.h.

#define sysWPPILaunchCmdPromptAndConfigure (sysAppLaunchCmdCustomBase + 6)

This is invoked to bring up the prompt dialog (WPPI decides if prompt is necessary) or pass any kind of data to the WPPI. Optionally, before exiting, a WPPI can set the netIFSettingDot1XConfig setting to pass information back to the 802.1X plugin.

Definition at line 183 of file PalmWPPI.h.

Top | Palm Developer Network © 2004-2008, Palm, Inc. All rights reserved. Generated on Fri Jun 13 10:08:00 2008 for Palm API Guide