RasGetEntryProperties

The RasGetEntryProperties function retrieves the properties of a phone-book entry.

DWORD RasGetEntryProperties(
  LPCTSTR lpszPhonebook,   // pointer to full path and filename of 
                           // phone-book file
  LPCTSTR lpszEntry,       // pointer to an entry name
  LPRASENTRY lpRasEntry,   // buffer that receives entry information
  LPDWORD lpdwEntryInfoSize,  // size, in bytes, of the lpRasEntry 
                              // buffer
  LPBYTE lpbDeviceInfo,    // buffer that receives device-specific 
                           // configuration information
  LPDWORD lpdwDeviceInfoSize  // size, in bytes, of the 
                              // lpbDeviceInfo buffer
);
 

Parameters

lpszPhonebook

Windows NT: Pointer to a null-terminated string that specifies the full path and filename of a phone-book (.PBK) file. If this parameter is NULL, the function uses the current default phone-book file. The default phone-book file is the one selected by the user in the User Preferences property sheet of the Dial-Up Networking dialog box.

lpszEntry

Pointer to a null-terminated string containing an existing entry name. If you specify an empty string, "", the function returns default values in the buffers pointed to by the lpRasEntry and lpbDeviceInfo parameters.

lpRasEntry

Pointer to a RASENTRY structure followed by additional bytes for the alternate phone number list, if there is one. The structure receives the connection data associated with the phone-book entry specified by the lpszEntry parameter. Before calling the function, set the dwSize member of the structure to sizeof(RASENTRY) to identify the version of the structure. This parameter can be NULL.

lpdwEntryInfoSize

Pointer to a variable that contains the size, in bytes, of the lpRasEntry buffer. On return, the function sets this variable to the number of bytes required. This parameter can be NULL if the lpRasEntry parameter is NULL.

To determine the required buffer size, call RasGetEntryProperties with lpRasEntry set to NULL and *lpdwEntryInfoSize set to zero. The function returns the required buffer size in *lpdwEntryInfoSize.

lpbDeviceInfo

Pointer to a buffer that receives device-specific configuration information. This is opaque TAPI device configuration information that you should not manipulate directly. This parameter can be NULL. For more information about TAPI device configuration, see the lineGetDevConfig function in the Win32 Telephony (TAPI) Programmer's Reference.

Windows NT: This parameter is unused. The calling function should set this parameter to NULL.

lpdwDeviceInfoSize

Pointer to a variable that contains the size, in bytes, of the buffer specified by the lpbDeviceInfo parameter. On return, the function sets this variable to the number of bytes required. This parameter can be NULL if the lpbDeviceInfo parameter s NULL.

To determine the required buffer size, call RasGetEntryProperties with lpbDeviceInfo set to NULL and *lpdwDeviceInfoSize set to zero. The function returns the required buffer size in *lpdwDeviceInfoSize.

Windows NT: This parameter is unused. The calling function should set this parameter to NULL.

Return Values

If the function succeeds, the return value is zero.

If the function fails, the return value can be one of the following error codes.

Remarks

Windows CE: For Windows CE version 1.0, the lpbDeviceInfo and lpdwDeviceInfoSize parameters are ignored and should be set to NULL. To retrieve device specific configuration information use the RasGetEntryDevConfig function.

For Windows CE version 2.0 and later, device configuration information can be retrieved by using the lpbDeviceInfo and lpdwDeviceInfoSize parameters.

QuickInfo

  Windows NT: Requires version 4.0 or later.
  Windows: Requires Windows 95 OSR2 or later.
  Windows CE: Requires version 1.0 or later.
  Header: Declared in ras.h.
  Import Library: Use rasapi32.lib.
  Unicode: Implemented as Unicode and ANSI versions on Windows NT.

See Also

Remote Access Service Overview, RAS Server Administration Functions, RASENTRY, RasSetEntryProperties