Condividi tramite


WPUGetQOSTemplate function

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

The WPUGetQOSTemplate function retrieves a QOS template for a particular service provider.

Syntax

INT WPUGetQOSTemplate(
  _In_  const LPGUID   lpProviderId,
  _In_        LPWSABUF lpQOSName,
  _Out_       LPQOS    lpQOS
);

Parameters

lpProviderId [in]

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

lpQOSName [in]

Specifies the QOS template name.

lpQOS [out]

Pointer to a QOS structure.

Return value

If WPUGetQOSTemplate succeeds, the return value is zero. If the function fails, the return value is SOCKET_ERROR. For extended error information, call WSAGetLastError.

Return code Description
WSAEFAULT
The lpQOS or lpQOSName parameter is not a valid part of the user address space.
WSAEINVAL
The specified lpProviderId is invalid, or the lpQOS template is invalid.
WSA_NODATA
The specified QOS name could not be found.
WSAENOBUFS
The ProviderSpecific buffer is too small.

Remarks

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

The WPUGetQOSTemplate function retrieves a QOS-named template containing the associated QOS structure. If lpProviderId is NULL, WPUGetQOSTemplate attempts to find the QOS-named template in the global list of QOS names. Otherwise, WPUGetQOSTemplate searches the template list specific to the service provider indicated by lpProviderId.

The lpQOS parameter can include a ProviderSpecific buffer for retrieval with the basic QOS structure. In this case, the ProviderSpecific buffer must be large enough to hold the provider-specific information stored in the template; otherwise WPUGetQOSTemplate returns WSAENOBUFS.

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

QOS

WSAGetQOSByName

WSCInstallQOSTemplate

WSCRemoveQOSTemplate