RasGetAutodialEnableA function (ras.h)

The RasGetAutodialEnable function indicates whether the AutoDial feature is enabled for a specified TAPI dialing location. For more information about TAPI dialing locations, see the TAPI Programmer's Reference in the Platform Software Development Kit (SDK).

Syntax

DWORD RasGetAutodialEnableA(
  [in]  DWORD  unnamedParam1,
  [out] LPBOOL unnamedParam2
);

Parameters

[in] unnamedParam1

Specifies the identifier of a TAPI dialing location.

[out] unnamedParam2

Pointer to a BOOL variable that receives a nonzero value if AutoDial is enabled for the specified dialing location, or zero if it is not enabled.

Return value

If the function succeeds, the return value is ERROR_SUCCESS.

If the function fails, the return value is from Routing and Remote Access Error Codes or Winerror.h.

Remarks

Note

The ras.h header defines RasGetAutodialEnable as an alias which automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.

Requirements

Requirement Value
Minimum supported client Windows 2000 Professional [desktop apps only]
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header ras.h
Library Rasapi32.lib
DLL Rasapi32.dll

See also

RasSetAutodialEnable

Remote Access Service (RAS) Overview

Remote Access Service Functions