RasSetEntryProperties
[New
- Windows NT]
The RasSetEntryProperties
function changes the connection information for an entry in the phone book
or creates a new phone-book entry.
DWORD RasSetEntryProperties(
LPTSTR lpszPhonebook, |
// pointer to full
path and filename of phone-book file |
LPTSTR lpszEntry, |
// pointer to an
entry name |
LPRASENTRY lpRasEntry, |
// buffer that
contains entry information |
DWORD dwEntryInfoSize, |
// size, in bytes,
of the lpRasEntry buffer |
LPBYTE lpbDeviceInfo, |
// buffer that
contains device-specific configuration information |
DWORD dwDeviceInfoSize |
// 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 entry name.
If the entry
name matches an existing entry, RasSetEntryProperties modifies the
properties of that entry.
If the entry
name does not match an existing entry, RasSetEntryProperties creates a
new phone-book entry. For new entries, call the RasValidateEntryName
lpRasEntry
Pointer to a RASENTRY
The structure
might be followed by an array of null-terminated alternate phone number
strings. The last string is terminated by two consecutive null characters. The dwAlternateOffset
member of the RASENTRY structure contains the offset to the first
string.
dwEntryInfoSize
Specifies the
size, in bytes, of the buffer specified by the lpRasEntry parameter.
lpbDeviceInfo
Pointer to a
buffer containing device-specific configuration information. This is opaque
TAPI device configuration information. For more information about TAPI device
configuration, see the Win32 Telephony (TAPI) Programmer s Reference.
dwDeviceInfoSize
Specifies the
size, in bytes, of the lpbDeviceInfo buffer.
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_BUFFER_INVALID |
The address
or buffer specified by lpRasEntry is invalid. |
ERROR_CANNOT_OPEN_PHONEBOOK |
The phone
book is corrupted or missing components. |
See Also