Preliminary User Guide, Rev. 2

USS-720

February 1999

USB Device Driver

 

 

4 I/O Control Codes (continued)

4.6 IOCTL_ABORT_PIPE

IOCTL_ABORT_PIPE cancels any pending transfers for the specified pipe. The pipe state and endpoint state are unaffected. Details regarding parameters and error codes follow.

4.6.1 Parameters

lpInBuffer—Points to a buffer that contains a single byte that specifies one of the following values:

Value

Description

 

 

BULK_OUT_PIPE

Bulk Out pipe.

 

 

BULK_IN_PIPE

Bulk In pipe.

 

 

INTERRUPT_PIPE

Interrupt pipe.

 

 

nInBufferSize—Specifies the size (in bytes) of the buffer pointed to by lpInBuffer. For this operation, this value should be 1.

lpOutBuffer—Points to an output buffer. Not used with this operation. Set to NULL.

nOutBufferSize—Specifies the size (in bytes) of the buffer pointed to by lpOutBuffer. Not used with this operation. Set to zero.

lpBytesReturned—Points to a DWORD that receives the actual size (in bytes) of the data stored into lpOutBuffer. Not used with this operation.

4.6.2 Notes

None.

4.6.3 Error Codes

ERROR_INVALID_PIPE_INDEX—Specified pipe is invalid for this device instance or invalid for the current alter- nate interface setting.

STATUS_INVALID_PARAMETER—nInBufferSize cannot be zero.

STATUS_INSUFFICIENT_RESOURCES—Not enough memory to allocate a request to abort the pipe on this device instance.

Lucent Technologies Inc.

7-15

Page 73
Image 73
Lucent Technologies USS-720 manual Ioctlabortpipe, Value Description, Bulkoutpipe, Bulkinpipe, Interruptpipe