RasGetEntryProperties
[New
- Windows NT]
The RasGetEntryProperties
function retrieves the properties of a phone-book entry.
DWORD RasGetEntryProperties(
|
LPTSTR lpszPhonebook, |
// pointer to full
path and filename of phone-book file |
|
LPTSTR 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 Win32 Telephony (TAPI) Programmer s Reference.
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.
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.
|
Value |
Meaning |
|
ERROR_INVALID_PARAMETER
|
The
function was called with an invalid parameter. |
|
ERROR_BUFFER_INVALID
|
The address
or buffer specified by lpRasEntry is invalid. |
|
ERROR_BUFFER_TOO_SMALL
|
The buffer
size indicated in lpdwEntryInfoSize is too small. |
|
ERROR_CANNOT_OPEN_PHONEBOOK
|
The phone
book is corrupted or is missing components. |
|
ERROR_CANNOT_FIND_PHONEBOOK_ENTRY |
The
phone-book entry does not exist. |
See Also