Partager via


WSCRemoveQOSTemplate function

[ This function is not supported as of Windows Vista.]

The WSCRemoveQOSTemplate function removes a QOS template. Note that the caller of this function must have administrative rights.

Syntax

BOOL WSCRemoveQOSTemplate(
  _In_ const LPGUID   lpProviderId,
  _In_       LPWSABUF lpQOSName
);

Parameters

lpProviderId [in]

Pointer to a provider-selected globally unique identifier (GUID).

lpQOSName [in]

Specifies the QOS template name.

Return value

If WSCRemoveQOSTemplate succeeds, the return value is TRUE. If the function fails, the return value is FALSE. For extended error information, call WSAGetLastError.

Return code Description
WSAEINVAL
The specified QOS template name is invalid.
WSA_NODATA
The specified QOS template could not be found.
WSEFAULT
One or more of the parameters is not a valid part of the user address space.

Remarks

In Windows Vista and later, this function always returns with an error.

The WSCRemoveQOSTemplate function deletes a QOS template previously installed with WSCInstallQOSTemplate. If lpProviderId is NULL, WSCRemoveQOSTemplate attempts to find and delete a QOS template from the global list of QOS names. Otherwise, WSCRemoveQOSTemplate attempts to find and delete a QOS template specific to the service provider associated with lpProviderId. You cannot delete the base set of QOS names included with Windows Sockets 2. The WSAEINVAL error code will be returned if such an attempt is made.

Requirements

Minimum supported client
Windows 2000 Professional [desktop apps only]
Minimum supported server
Windows 2000 Server [desktop apps only]
End of client support
Windows XP
End of server support
Windows Server 2003
Header
Qosname.h
Library
Qosname.lib
DLL
Qosname.dll

See also

WPUGetQOSTemplate

WSAGetQOSByName

WSCInstallQOSTemplate