Edit

Share via

WinUsb_SetPipePolicy function (winusb.h)

  • Article

The WinUsb_SetPipePolicy function sets the policy for a specific pipe associated with an endpoint on the device. This is a synchronous operation.

Syntax

BOOL WinUsb_SetPipePolicy(
  [in] WINUSB_INTERFACE_HANDLE InterfaceHandle,
  [in] UCHAR                   PipeID,
  [in] ULONG                   PolicyType,
  [in] ULONG                   ValueLength,
  [in] PVOID                   Value
);

Parameters

[in] InterfaceHandle

An opaque handle to an interface that contains the endpoint with which the pipe is associated.

To set policy for the pipe associated with the endpoint in the first interface, use the handle returned by WinUsb_Initialize. For all other interfaces, use the handle to the target interface, retrieved by WinUsb_GetAssociatedInterface.

[in] PipeID

An 8-bit value that consists of a 7-bit address and a direction bit. This parameter corresponds to the bEndpointAddress field in the endpoint descriptor.

[in] PolicyType

A ULONG variable that specifies the policy parameter to change. The Value parameter contains the new value for the policy parameter, defined in winusbio.h. For information about how to use each of the pipe policies and the resulting behavior, see WinUSB Functions for Pipe Policy Modification.

[in] ValueLength

The size, in bytes, of the buffer at Value.

[in] Value

The new value for the policy parameter that PolicyType specifies. The size of this input parameter depends on the policy to change. For information about the size of this parameter, see the description of the PolicyType parameter.

Return value

WinUsb_SetPipePolicy returns TRUE if the operation succeeds. Otherwise, this function returns FALSE, and the caller can retrieve the logged error by calling GetLastError.

GetLastError can return the following error code.

Return code Description
ERROR_INVALID_HANDLE
 The caller passed NULL in the InterfaceHandle parameter.
ERROR_INVALID_PARAMETER
The caller passed an invalid size for the policy parameter buffer in the ValueLength parameter.
ERROR_NOT_ENOUGH_MEMORY
 Indicates that there is insufficient memory to perform the operation.

Requirements

Requirement Value
Target Platform Universal
Header winusb.h (include Winusb.h)
Library Winusb.lib
DLL Winusb.dll

See also

WinUSB

WinUSB Functions

WinUSB Functions for Pipe Policy Modification

WinUsb_GetPipePolicy

WinUsb_Initialize