RasGetAutodialParam
[New
- Windows NT]
The RasGetAutodialParam
function retrieves the value of an AutoDial parameter.
DWORD RasGetAutodialParam(
DWORD dwKey, |
// indicates the
parameter to retrieve |
LPVOID lpvValue, |
// pointer to a
buffer that receives the value |
LPDWORD lpdwcbValue |
// size, in bytes,
of the buffer |
); |
|
Parameters
dwKey
Indicates the
AutoDial parameter to retrieve. This parameter can be one of the following values.
Value |
Meaning |
RASADP_DisableConnectionQuery |
The lpvValue
parameter returns a DWORD value. If this value is zero (the default),
AutoDial displays a dialog box to query the user before creating a
connection. If this value is 1, and the AutoDial database has the phone-book
entry to dial, AutoDial creates a connection without displaying the dialog
box. |
RASADP_LoginSessionDisable |
The lpvValue
parameter returns a DWORD value. If this value is 1, the system
disables all AutoDial connections for the current logon session. If this
value is zero (the default), AutoDial connections are enabled. The AutoDial
system service changes this value to zero when a new user logs on to the
workstation. |
RASADP_SavedAddressesLimit |
The lpvValue
parameter returns a DWORD value that indicates the maximum number of
addresses that AutoDial stores in the registry. AutoDial first stores
addresses that it used to create an AutoDial connection; then it stores
addresses that it learned after a RAS connection was created. Addresses written
using the RasSetAutodialAddress |
RASADP_FailedConnectionTimeout |
The lpvValue
parameter returns a DWORD value that indicates a timeout value, in
seconds. When an AutoDial connection attempt fails, the AutoDial system
service disables subsequent attempts to reach the same address for the
timeout period. This prevents AutoDial from displaying multiple connection
dialog boxes for the same logical request by an application. The default
value is 5. |
lpvValue
Pointer to a
buffer that receives the value for the specified parameter.
lpdwcbValue
Pointer to a DWORD
value. On input, set this value to indicate the size, in bytes, of the lpvValue
buffer. On output, this value indicates the actual size of the value written to
the 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_INVALID_PARAMETER |
The dwKey
or lpvValue parameter is invalid. |
ERROR_INVALID_SIZE |
The size
specified by the lpdwcbValue is too small. |
See Also