home *** CD-ROM | disk | FTP | other *** search
/ Team Palmtops 7 / Palmtops_numero07.iso / WinCE / SDKWindowsCE / AutoPC / apcsdk10.exe / data1.cab / Emulation_Include_Files / ras.h < prev    next >
Encoding:
C/C++ Source or Header  |  1999-05-13  |  12.7 KB  |  481 lines
  1. /*++
  2.  
  3. THIS CODE AND INFORMATION IS PROVIDED "AS IS" WITHOUT WARRANTY OF
  4. ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO
  5. THE IMPLIED WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A
  6. PARTICULAR PURPOSE.
  7. Copyright (c) 1995, 1996, 1997  Microsoft Corporation
  8.  
  9. Module Name:
  10.  
  11. ras.h
  12.  
  13. Abstract:
  14.  
  15. Remote Access Service structures and defines
  16.  
  17. Notes: 
  18.  
  19. --*/
  20.  
  21. // @CESYSGEN IF CE_MODULES_PPP
  22. #ifndef _RAS_H_
  23. #define _RAS_H_
  24.  
  25. #ifdef __cplusplus
  26. extern "C" {
  27. #endif
  28.  
  29. #ifndef UNLEN
  30. #include <lmcons.h>
  31. #endif
  32. #include <tapi.h>
  33.  
  34. #include "pshpack4.h"
  35.  
  36. #define RAS_MaxEntryName      20
  37. #define RAS_MaxDeviceName     32
  38. #define RAS_MaxDeviceType     16
  39. #define RAS_MaxParamKey       32
  40. #define RAS_MaxParamValue     128
  41. #define RAS_MaxPhoneNumber    128
  42. #define RAS_MaxCallbackNumber 48
  43. #define RAS_MaxIpAddress      15
  44. #define RAS_MaxIpxAddress     21
  45.  
  46. // Ras extensions
  47.  
  48. #define    RAS_MaxAreaCode            (10)            // TBD
  49. #define    RAS_MaxPadType            (32)            // TBD
  50. #define    RAS_MaxX25Address        (200)            // TBD
  51. #define    RAS_MaxFacilities        (200)            // TBD
  52. #define    RAS_MaxUserData            (200)            // TBD
  53.  
  54. // RAS IP Address
  55.  
  56. typedef    struct    tagRasIpAddr
  57. {
  58.     BYTE    a;
  59.     BYTE    b;
  60.     BYTE    c;
  61.     BYTE    d;
  62. }
  63. RASIPADDR;
  64.  
  65. // RAS Entry Definition
  66.  
  67. typedef    struct    tagRasEntry    
  68. {
  69.     DWORD        dwSize;
  70.     DWORD        dwfOptions;
  71.     DWORD        dwCountryID;
  72.     DWORD        dwCountryCode;
  73.     TCHAR        szAreaCode[ RAS_MaxAreaCode + 1 ];
  74.     TCHAR        szLocalPhoneNumber[ RAS_MaxPhoneNumber + 1 ];
  75.     DWORD        dwAlternatesOffset;
  76.     RASIPADDR    ipaddr;
  77.     RASIPADDR    ipaddrDns;
  78.     RASIPADDR    ipaddrDnsAlt;
  79.     RASIPADDR    ipaddrWins;
  80.     RASIPADDR    ipaddrWinsAlt;
  81.     DWORD        dwFrameSize;
  82.     DWORD        dwfNetProtocols;
  83.     DWORD        dwFramingProtocol;
  84.     TCHAR        szScript[ MAX_PATH ];
  85.     TCHAR        szAutoDialDll[ MAX_PATH ];
  86.     TCHAR        szAutoDialFunc[ MAX_PATH ];
  87.     TCHAR        szDeviceType[ RAS_MaxDeviceType + 1 ];
  88.     TCHAR        szDeviceName[ RAS_MaxDeviceName + 1 ];
  89.     TCHAR        szX25PadType[ RAS_MaxPadType + 1 ];
  90.     TCHAR        szX25Address[ RAS_MaxX25Address + 1 ];
  91.     TCHAR        szX25Facilities[ RAS_MaxFacilities + 1 ];
  92.     TCHAR        szX25UserData[ RAS_MaxUserData + 1 ];
  93.     DWORD        dwChannels;
  94.     DWORD        dwReserved1;
  95.     DWORD        dwReserved2;
  96. }
  97. RASENTRY, *LPRASENTRY;
  98.  
  99.  
  100. /* Describes Country Information
  101. */
  102. typedef struct  tagRasCtryInfo {
  103.     DWORD       dwSize;
  104.     DWORD       dwCountryID;
  105.     DWORD       dwNextCountryID;
  106.     DWORD       dwCountryCode;
  107.     DWORD       dwCountryNameOffset;
  108. } RASCTRYINFO;
  109. typedef RASCTRYINFO * LPRASCTRYINFO;
  110.  
  111. /* Describes RAS Device Information
  112. */
  113. typedef struct  tagRasDevInfo {
  114.     DWORD       dwSize;
  115.     CHAR        szDeviceType[RAS_MaxDeviceType+1];
  116.     CHAR        szDeviceName[RAS_MaxDeviceName+1];
  117. } RASDEVINFO;
  118. typedef RASDEVINFO * LPRASDEVINFO;
  119.  
  120. /* RASENTRY 'dwfOptions' bit flags.
  121. */
  122. #define RASEO_UseCountryAndAreaCodes  0x00000001
  123. #define RASEO_SpecificIpAddr          0x00000002
  124. #define RASEO_SpecificNameServers     0x00000004
  125. #define RASEO_IpHeaderCompression     0x00000008
  126. #define RASEO_RemoteDefaultGateway    0x00000010
  127. #define RASEO_DisableLcpExtensions    0x00000020
  128. #define RASEO_TerminalBeforeDial      0x00000040
  129. #define RASEO_TerminalAfterDial       0x00000080
  130. #define RASEO_ModemLights             0x00000100
  131. #define RASEO_SwCompression           0x00000200
  132. #define RASEO_RequireEncryptedPw      0x00000400
  133. #define RASEO_RequireMsEncryptedPw    0x00000800
  134. #define RASEO_RequireDataEncryption   0x00001000
  135. #define RASEO_NetworkLogon            0x00002000
  136. #define RASEO_UseLogonCredentials     0x00004000
  137. #define RASEO_PromoteAlternates       0x00008000
  138. #define RASEO_SecureLocalFiles        0x00010000
  139. #define RASEO_DialAsLocalCall         0x00020000
  140.  
  141.  
  142. /* RASENTRY 'dwfNetProtocols' bit flags. (session negotiated protocols)
  143. */
  144. #define RASNP_Netbeui       0x00000001  // Negotiate NetBEUI
  145. #define RASNP_Ipx           0x00000002  // Negotiate IPX
  146. #define RASNP_Ip            0x00000004  // Negotiate TCP/IP
  147.  
  148.  
  149. /* RASENTRY 'dwFramingProtocols' (framing protocols used by the server)
  150. */
  151. #define RASFP_Ppp           0x00000001  // Point-to-Point Protocol (PPP)
  152. #define RASFP_Slip          0x00000002  // Serial Line Internet Protocol (SLIP)
  153. #define RASFP_Ras           0x00000004  // Microsoft proprietary protocol
  154.  
  155.  
  156. /* RASENTRY 'szDeviceType' strings
  157. */
  158. #define RASDT_Direct        TEXT("direct")    // Direct Connect (WINCE Extension)
  159. #define RASDT_Modem         TEXT("modem")     // Modem
  160. #define RASDT_Isdn          TEXT("isdn")      // ISDN
  161. #define RASDT_X25           TEXT("x25")       // X.25
  162.  
  163.  
  164.  
  165. DECLARE_HANDLE( HRASCONN );
  166. typedef HRASCONN *LPHRASCONN;
  167.  
  168. // Identifies an active RAS connection.  (See RasEnumConnections)
  169.  
  170. typedef struct tagRASCONN
  171. {
  172.     DWORD    dwSize;
  173.     HRASCONN hrasconn;
  174.     TCHAR    szEntryName[ RAS_MaxEntryName + 1 ];
  175. } 
  176. RASCONN, *LPRASCONN;
  177.  
  178. // Enumerates intermediate states to a connection.  (See RasDial)
  179.  
  180. #define RASCS_PAUSED 0x1000
  181. #define RASCS_DONE   0x2000
  182.  
  183. typedef enum tagRASCONNSTATE
  184. {
  185.     RASCS_OpenPort = 0,
  186.     RASCS_PortOpened,
  187.     RASCS_ConnectDevice,
  188.     RASCS_DeviceConnected,
  189.     RASCS_AllDevicesConnected,
  190.     RASCS_Authenticate,
  191.     RASCS_AuthNotify,
  192.     RASCS_AuthRetry,
  193.     RASCS_AuthCallback,
  194.     RASCS_AuthChangePassword,
  195.     RASCS_AuthProject,
  196.     RASCS_AuthLinkSpeed,
  197.     RASCS_AuthAck,
  198.     RASCS_ReAuthenticate,
  199.     RASCS_Authenticated,
  200.     RASCS_PrepareForCallback,
  201.     RASCS_WaitForModemReset,
  202.     RASCS_WaitForCallback,
  203.     RASCS_Projected,
  204.  
  205.     RASCS_Interactive             = RASCS_PAUSED,
  206.     RASCS_RetryAuthentication,
  207.     RASCS_CallbackSetByCaller,
  208.     RASCS_PasswordExpired,
  209.  
  210.     RASCS_Connected             = RASCS_DONE,
  211.     RASCS_Disconnected
  212. } 
  213. RASCONNSTATE, *LPRASCONNSTATE;
  214.  
  215.  
  216. // Describes the status of a RAS connection.  (See RasConnectionStatus)
  217.  
  218. typedef struct tagRASCONNSTATUS
  219. {
  220.     DWORD        dwSize;
  221.     RASCONNSTATE rasconnstate;
  222.     DWORD        dwError;
  223.     TCHAR        szDeviceType[ RAS_MaxDeviceType + 1 ];
  224.     TCHAR        szDeviceName[ RAS_MaxDeviceName + 1 ];
  225. }
  226. RASCONNSTATUS, *LPRASCONNSTATUS;
  227.  
  228.  
  229. // Describes connection establishment parameters.  (See RasDial)
  230.  
  231. typedef struct tagRASDIALPARAMS
  232. {
  233.     DWORD dwSize;
  234.     TCHAR szEntryName[ RAS_MaxEntryName + 1 ];
  235.     TCHAR szPhoneNumber[ RAS_MaxPhoneNumber + 1 ];
  236.     TCHAR szCallbackNumber[ RAS_MaxCallbackNumber + 1 ];
  237.     TCHAR szUserName[ UNLEN + 1 ];
  238.     TCHAR szPassword[ PWLEN + 1 ];
  239.     TCHAR szDomain[ DNLEN + 1 ];
  240. }
  241. RASDIALPARAMS, *LPRASDIALPARAMS;
  242.  
  243.  
  244. // Describes extended connection establishment options.  (See RasDial)
  245.  
  246. typedef struct tagRASDIALEXTENSIONS
  247. {
  248.     DWORD dwSize;
  249.     DWORD dwfOptions;
  250.     HWND  hwndParent;
  251.     DWORD reserved;
  252. } 
  253. RASDIALEXTENSIONS, *LPRASDIALEXTENSIONS;
  254.  
  255. // 'dwfOptions' bit flags.
  256.  
  257. #define RDEOPT_UsePrefixSuffix           0x00000001
  258. #define RDEOPT_PausedStates              0x00000002
  259. #define RDEOPT_IgnoreModemSpeaker        0x00000004
  260. #define RDEOPT_SetModemSpeaker           0x00000008
  261. #define RDEOPT_IgnoreSoftwareCompression 0x00000010
  262. #define RDEOPT_SetSoftwareCompression    0x00000020
  263.  
  264.  
  265. // Describes an enumerated RAS phone book entry name.  (See RasEntryEnum)
  266.  
  267. typedef struct tagRASENTRYNAME
  268. {
  269.     DWORD dwSize;
  270.     TCHAR szEntryName[ RAS_MaxEntryName + 1 ];
  271. } 
  272. RASENTRYNAME, *LPRASENTRYNAME;
  273.  
  274.  
  275. // Protocol code to projection data structure mapping.
  276.  
  277. typedef enum tagRASPROJECTION
  278. {
  279.     RASP_Amb = 0x10000,
  280.     RASP_PppNbf = 0x803F,
  281.     RASP_PppIpx = 0x802B,
  282.     RASP_PppIp = 0x8021
  283. }
  284. RASPROJECTION, *LPRASPROJECTION;
  285.  
  286. /* 
  287. ** Describes the result of a RAS AMB (Authentication Message Block)
  288. ** projection.  This protocol is used with NT 3.1 and OS/2 1.3 downlevel
  289. ** RAS servers.
  290. */
  291.  
  292. typedef struct tagRASAMBA
  293. {
  294.     DWORD dwSize;
  295.     DWORD dwError;
  296.     TCHAR  szNetBiosError[ NETBIOS_NAME_LEN + 1 ];
  297.     BYTE  bLana;
  298. } 
  299. RASAMB, *LPRASAMB;
  300.  
  301. // Describes the result of a PPP NBF (NetBEUI) projection.
  302.  
  303. typedef struct tagRASPPPNBFW
  304. {
  305.     DWORD dwSize;
  306.     DWORD dwError;
  307.     DWORD dwNetBiosError;
  308.     TCHAR szNetBiosError[ NETBIOS_NAME_LEN + 1 ];
  309.     TCHAR szWorkstationName[ NETBIOS_NAME_LEN + 1 ];
  310.     BYTE  bLana;
  311. } 
  312. RASPPPNBF, *LPRASPPPNBF;
  313.  
  314.  
  315. // Describes the results of a PPP IPX (Internetwork Packet Exchange)
  316. // projection.
  317.  
  318. typedef struct tagRASIPX
  319. {
  320.     DWORD dwSize;
  321.     DWORD dwError;
  322.     TCHAR szIpxAddress[ RAS_MaxIpxAddress + 1 ];
  323. } 
  324. RASPPPIPX, *LPRASPPPIPX;
  325.  
  326. // Describes the results of an PPP IP (Internet) projection.
  327.  
  328. typedef struct tagRASPPPIP
  329. {
  330.     DWORD dwSize;
  331.     DWORD dwError;
  332.     TCHAR szIpAddress[ RAS_MaxIpAddress + 1 ];
  333. } 
  334. RASPPPIP, *LPRASPPPIP;
  335.  
  336. // Describes results of a GET_WINS/DNS I/O control. If
  337. // the requested address has been negotiated the boolean
  338. // valid is TRUE and the IpAddress contains the address of
  339. // the requested server.  If Valid is false IpAddress is
  340. // zero.
  341.  
  342. typedef    struct    tagRASPPPAddr
  343. {
  344.     DWORD    dwSize;
  345.     DWORD    dwError;
  346.     BOOL    Valid;
  347.     DWORD    IpAddress;
  348. }
  349. RASPPPADDR;
  350.  
  351. //     RAS Control Structures
  352. //
  353. //     Control Request Enumeration
  354.  
  355. typedef    enum    tagRasCntlEnum
  356. {
  357.     RASCNTL_NULL,                                // NULL request
  358.     RASCNTL_SESSION_DELETE,                        // delete a session
  359.     RASCNTL_CONNECTION_HANGUP,                    // hangup connection
  360.     RASCNTL_USER_CREDENTIALS,                    // set user credentials
  361.     RASCNTL_SET_DEBUG,                            // set debug control params
  362.     RASCNTL_LOCK_STATUS,                        // get session's lock status
  363.     RASCNTL_PRINT_CS,                            // print cs info
  364.     RASCNTL_STATISTICS,                            // Get statistics
  365.  
  366.     // Add others here
  367. }
  368. RasCntlEnum_t;
  369.  
  370.  
  371. /* 
  372. ** If using RasDial message notifications, get the notification message code
  373. ** by passing this string to the RegisterWindowMessageA() API.
  374. ** WM_RASDIALEVENT is used only if a unique message cannot be registered.
  375. */
  376.  
  377. #define RASDIALEVENT        "RasDialEvent"
  378. #define WM_RASDIALEVENT     0xCCCD
  379.  
  380. /* 
  381. ** Prototypes for caller's RasDial callback handler.  Arguments are the
  382. ** message ID (currently always WM_RASDIALEVENT), the current RASCONNSTATE and
  383. ** the error that has occurred (or 0 if none).  Extended arguments are the
  384. ** handle of the RAS connection and an extended error code.
  385. */
  386.  
  387. typedef VOID (WINAPI *RASDIALFUNC )( UINT, RASCONNSTATE, DWORD );
  388. typedef VOID (WINAPI *RASDIALFUNC1)( HRASCONN, UINT, RASCONNSTATE, DWORD, DWORD );
  389.  
  390.  
  391. #ifdef UNDER_CE
  392.  
  393. // This structure is used by the RnaApp application on WINCE
  394. // to signal when a connection has occured.
  395.  
  396. typedef struct tagRNAAppInfo {
  397.     DWORD    dwSize;                    // The size of this structure
  398.     DWORD    hWndRNAApp;                // The handle of the RNAApp window
  399.     DWORD    Context;                // Context value specified on CmdLine
  400.     DWORD    ErrorCode;                // Last error code
  401.     TCHAR    RasEntryName[RAS_MaxEntryName+1];
  402. } RNAAPP_INFO, *PRNAAPP_INFO;
  403.  
  404.  
  405. #define RNA_RASCMD        WM_USER+1
  406. #define    RNA_ADDREF        1
  407. #define RNA_DELREF        2
  408. #endif
  409.  
  410. #include "poppack.h"
  411.  
  412. #ifndef RASAPI
  413. #define RASAPI
  414. #endif
  415.  
  416. DWORD RASAPI RasDial (LPRASDIALEXTENSIONS dialExtensions,
  417.            LPTSTR phoneBookPath,
  418.            LPRASDIALPARAMS rasDialParam,
  419.            DWORD NotifierType,
  420.            LPVOID notifier,
  421.            LPHRASCONN pRasConn);
  422. DWORD RASAPI RasHangup (HRASCONN Session);    // Kept for historical compatibility
  423. DWORD RASAPI RasHangUp (HRASCONN Session);
  424. DWORD RASAPI RasEnumEntries (LPWSTR Reserved,
  425.               LPWSTR lpszPhoneBookPath,
  426.               LPRASENTRYNAME lprasentryname,
  427.               LPDWORD lpcb,
  428.               LPDWORD lpcEntries);
  429. DWORD RASAPI RasGetEntryDialParams (LPWSTR lpszPhoneBook,
  430.                  LPRASDIALPARAMS lpRasDialParams,    
  431.                  LPBOOL lpfPassword);
  432. DWORD RASAPI RasSetEntryDialParams (LPWSTR lpszPhoneBook,
  433.                  LPRASDIALPARAMS lpRasDialParams,
  434.                  BOOL fRemovePassword);
  435. DWORD RASAPI RasGetEntryProperties (LPWSTR lpszPhoneBook,
  436.                  LPWSTR szEntry,
  437.                  LPBYTE lpbEntry,
  438.                  LPDWORD lpdwEntrySize,
  439.                  LPBYTE lpb,
  440.                  LPDWORD lpdwSize);
  441. DWORD RASAPI RasSetEntryProperties (LPWSTR lpszPhoneBook,        
  442.                  LPWSTR szEntry,
  443.                  LPBYTE lpbEntry,
  444.                  DWORD dwEntrySize,
  445.                  LPBYTE lpb,
  446.                  DWORD dwSize);
  447. DWORD RASAPI RasValidateEntryName (LPWSTR lpszPhonebook,        
  448.                 LPWSTR lpszEntry);
  449. DWORD RASAPI RasDeleteEntry (LPWSTR lpszPhonebook,
  450.               LPWSTR lpszEntry);
  451. DWORD RASAPI RasRenameEntry (LPWSTR lpszPhonebook,
  452.               LPWSTR lpszOldEntry,
  453.               LPWSTR lpszNewEntry);
  454. DWORD RASAPI RasEnumConnections (LPRASCONN lprasconn,
  455.               LPDWORD lpcb,
  456.               LPDWORD lpcConnections);
  457. DWORD RASAPI RasGetConnectStatus (HRASCONN rasconn,                
  458.                LPRASCONNSTATUS lprasconnstatus);
  459. DWORD RASAPI RasGetEntryDevConfig (LPCTSTR szPhonebook,
  460.                 LPCTSTR szEntry,
  461.                 LPDWORD pdwDeviceID,
  462.                 LPDWORD pdwSize,
  463.                 LPVARSTRING pDeviceConfig);
  464. DWORD RASAPI RasSetEntryDevConfig (LPCTSTR szPhonebook,
  465.                 LPCTSTR szEntry,
  466.                 DWORD dwDeviceID,
  467.                 LPVARSTRING lpDeviceConfig);
  468.  
  469. #ifdef __cplusplus
  470. }
  471. #endif
  472.  
  473.  
  474. #ifdef WINCEOEM
  475. #include <pras.h>    // internal defines 
  476. #endif
  477.  
  478. #endif // _RAS_H_
  479.  
  480. // @CESYSGEN ENDIF
  481.