WSCRemoveQOSTemplate

[This is preliminary documentation and subject to change.]

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

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 GQOS template name.

Return Values

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

Remarks

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

Error Codes

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

QuickInfo

  Windows NT: Requires version 5.0 or later.
  Windows: Requires Windows 98.
  Windows CE: Unsupported.
  Header: Declared in qosname.h.

See Also

WPUGetQOSTemplate, WSAGetQOSByName, WSCInstallQOSTemplate