RasDeleteSubEntryW function (ras.h)

Article
02/22/2024

The RasDeleteSubEntry function deletes the specified subentry from the specified phone-book entry.

Syntax

DWORD RasDeleteSubEntryW(
  [in] LPCWSTR pszPhonebook,
  [in] LPCWSTR pszEntry,
  [in] DWORD   dwSubEntryId
);

Parameters

[in] pszPhonebook

Pointer to a null-terminated string that specifies the full path and file name of a phone-book (PBK) file. If this parameter is NULL, the function uses the current default phone-book file.

[in] pszEntry

Pointer to a null-terminated string that contains the name of an existing entry from which a subentry is to be deleted.

[in] dwSubEntryId

Specifies the one-based index of the subentry.

Return value

If the function succeeds, the return value is ERROR_SUCCESS.

If the function fails, the return value is one of the following error codes or a value from Routing and Remote Access Error Codes or Winerror.h.

Remarks

Note

The ras.h header defines RasDeleteSubEntry 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 XP [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Target Platform	Windows
Header	ras.h
Library	Rasapi32.lib
DLL	Rasapi32.dll