API Guide Home (Online version only) |

# PalmVPPI.h File Reference

## Detailed Description

This is the API for VPN panel plug-ins (VPPIs).

Version:
  1.0

The VPN panel allows the user to manage their VPN accounts. Each plug-in provides support for a specific VPN protocol such as PPTP or IPSec. A VPPI provides access to the user interface of a VPN client. An NPPI (Network panel plug-in) provides the underlying implementation as well as an alternate user interface.

Definition in file PalmVPPI.h.

Go to the source code of this file.

## Data Structures

- struct VPNAccountType
    VPN Account structure. More...
- struct SysVPPILaunchCmdGetAccountsType
    Structure used by the VPN Panel to query the account from a VPPI. More...
- struct SysVPPILaunchCmdEditAccountType
    Structure used by the VPN Panel to edit an account. More...
- struct SysVPPILaunchCmdDeleteAccountType
    Structure used by the VPN Panel to delete an account. More...
- struct SysVPPILaunchCmdSetCurrentAccountType
    Structure used by the VPN Panel to set the current account. More...
- struct SysVPPILaunchCmdPromptAndConfigureType
    Structure used by the VPN Panel to request the VPPI to display a dialog. More...
- struct SysVPPILaunchCmdProgressPaintType
    Structure used by the VPN Panel to show the progess dialog. More...
- struct SysVPPILaunchCmdErrorDialogType
    Structure used by the VPN Panel to show the error dialog. More...
- struct SysVPPILaunchCmdClearPWCacheType
    Structure used by the VPN Panel to clear the password cache. More...
- struct SysVPPILaunchCmdWillPWPromptType
    Structure used by the VPN Panel to determine is the VPPI will prompt for password. More...

## Defines

- #define sysFileTVPNPanelPlugin 'Vppi'
- #define kMaxVPNAccountNameLength 31
- #define sysVPPILaunchCmdGetAccounts sysAppLaunchCmdCustomBase
- #define sysVPPILaunchCmdEditAccount (sysAppLaunchCmdCustomBase + 1)
- #define sysVPPILaunchCmdDeleteAccount (sysAppLaunchCmdCustomBase + 2)
- #define sysVPPILaunchCmdSetCurrentAccount (sysAppLaunchCmdCustomBase + 3)
- #define sysVPPILaunchCmdPromptAndConfigure (sysAppLaunchCmdCustomBase + 4)
- #define sysVPPILaunchCmdProgressPaint (sysAppLaunchCmdCustomBase + 5)
- #define sysVPPILaunchCmdErrorDialog (sysAppLaunchCmdCustomBase + 6)
- #define sysVPPILaunchCmdClearPWCache (sysAppLaunchCmdCustomBase + 7)
- #define sysVPPILaunchCmdWillPWPrompt (sysAppLaunchCmdCustomBase + 8)

## Define Documentation

#define kMaxVPNAccountNameLength 31

Account name maximum length.

Definition at line 30 of file PalmVPPI.h.

#define sysFileTVPNPanelPlugin 'Vppi'

Database type for VPN panel plug-ins.

Definition at line 27 of file PalmVPPI.h.

#define sysVPPILaunchCmdClearPWCache (sysAppLaunchCmdCustomBase + 7)

Launch code used by the VPN Panel to clear the password cache.

Definition at line 125 of file PalmVPPI.h.

#define sysVPPILaunchCmdDeleteAccount (sysAppLaunchCmdCustomBase + 2)

Launch code used by the VPN Panel to delete an account.

Definition at line 68 of file PalmVPPI.h.

#define sysVPPILaunchCmdEditAccount (sysAppLaunchCmdCustomBase + 1)

Launch code used by the VPN Panel to edit an account.

Definition at line 54 of file PalmVPPI.h.

#define sysVPPILaunchCmdErrorDialog (sysAppLaunchCmdCustomBase + 6)

Launch code used by the VPN Panel to show the error dialog.

Definition at line 114 of file PalmVPPI.h.

#define sysVPPILaunchCmdGetAccounts sysAppLaunchCmdCustomBase

Launch code used by the VPN Panel to get the account list.

Definition at line 42 of file PalmVPPI.h.

#define sysVPPILaunchCmdProgressPaint (sysAppLaunchCmdCustomBase + 5)

Launch code used by the VPN Panel to show the progess dialog.

Definition at line 102 of file PalmVPPI.h.

#define sysVPPILaunchCmdPromptAndConfigure (sysAppLaunchCmdCustomBase + 4)

Launch code used by the VPN Panel to request the VPPI to display a dialog.

Definition at line 90 of file PalmVPPI.h.

#define sysVPPILaunchCmdSetCurrentAccount (sysAppLaunchCmdCustomBase + 3)

Launch code used by the VPN Panel to set the current account.

Definition at line 79 of file PalmVPPI.h.

#define sysVPPILaunchCmdWillPWPrompt (sysAppLaunchCmdCustomBase + 8)

Launch code used by the VPN Panel to determine is the VPPI will prompt for password.

Definition at line 135 of file PalmVPPI.h.

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