RasSetAutodialAddress
[New
- Windows NT]
The RasSetAutodialAddress
function can add an address to the AutoDial mapping database. Alternatively,
the function can delete or modify the data associated with an existing address
in the database.
DWORD RasSetAutodialAddress(
|
LPTSTR lpszAddress, |
// pointer to a
network address string |
|
DWORD dwReserved, |
// reserved; must
be zero |
|
LPRASAUTODIALENTRY lpAutoDialEntries, |
// pointer to
buffer containing AutoDial entry data |
|
DWORD dwcbAutoDialEntries, |
// size, in bytes,
of the buffer |
|
DWORD dwcAutoDialEntries |
// number of
entries in the buffer |
|
); |
|
Parameters
lpszAddress
Pointer to a
null-terminated string that specifies the address to add, delete, or modify.
This can be an IP address ( 127.95.1.4 ), Internet host name
( www.microsoft.com ), or NetBIOS name ( products1 ).
dwReserved
Reserved;
must be zero.
lpAutoDialEntries
Pointer to an
array of one or more RASAUTODIALENTRY structures to be associated with the lpszAddress
address. If lpAutoDialEntries is NULL and dwcbAutodialEntries is
zero, RasSetAutodialAddress deletes all structures associated with lpszAddress
from the mapping database.
dwcbAutoDialEntries
Specifies the
size, in bytes, of the lpAutodialEntries buffer.
dwcAutoDialEntries
Specifies the
number of RASAUTODIALENTRY structures in the lpAutoDialEntries
buffer.
Return Values
If the
function succeeds, the return value is zero.
If the
function fails, the return value is one of the following error codes.
|
Value |
Meaning |
|
ERROR_INVALID_SIZE |
The dwSize
member of the RASAUTODIALENTRY structure is an invalid value. |
|
ERROR_INVALID_PARAMETER |
The lpszAddress
parameter was NULL. |
Remarks
An address in
the AutoDial mapping database can have any number of associated RASAUTODIALENTRY
entries. Each entry specifies AutoDial information for a particular TAPI
dialing location.
If the
address specified by the lpszAddress parameter is an existing address in
the database and the lpAutoDialEntries parameter is not NULL, the RasSetAutodialAddress
function modifies the set of AutoDial entries associated with the address. If
an entry in the lpAutoDialEntries array specifies a dialing location for
which the address already has an entry, the function replaces the existing
entry with the new entry. Otherwise, the function simply adds the lpAutoDialEntries
entries to the set of entries for the address.
If the lpszAddress
address exists in the database and lpAutoDialEntries is NULL and dwcbAutodialEntries
is zero, RasSetAutodialAddress deletes the address from the database.
If the lpszAddress
address does not exist in the database, RasSetAutodialAddress adds the
address to the database. The lpAutoDialEntries parameter specifies the
AutoDial entries to associate with the new address.
See Also