Platform SDK: RAS/Routing and RAS |
The RasGetEntryProperties function retrieves the properties of a phone-book entry.
DWORD RasGetEntryProperties( LPCTSTR lpszPhonebook, // pointer to full path and // file name of phone-book file LPCTSTR 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 );
sizeof(RASENTRY)
to identify the version of the structure. This parameter can be 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.
Windows NT/2000: This parameter is unused. The calling function should set this parameter to 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.
Windows NT/2000: This parameter is unused. The calling function should set this parameter to NULL.
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_INVALID_SIZE | The value of the dwSize member of the lpRasEntry is too small. |
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. |
Windows NT/2000: Requires Windows NT 4.0 or later.
Windows 95/98: Requires Windows 95 OSR2 or later.
Header: Declared in Ras.h.
Library: Use Rasapi32.lib.
Unicode: Implemented as Unicode and ANSI versions on Windows NT/2000.
Remote Access Service (RAS) Overview, Remote Access Service Functions, RASENTRY, RasSetEntryProperties