www.beck-ipc.com

@CHIP-RTOS C Library V2.06 - USB API


usbHostGetString

Retrieves a string from a given device

int usbHostGetString( unsigned char driverId,

unsigned char address,
unsigned char stringId,
char far *string );

Parameters

driverId

ID of the user driver

address

Address of the resp. device

stringId

ID of the string that is desired

string

Pointer to a buffer where the string is to be stored; Must be large enough to store a string consisting of USB_SPEC_MAX_STRING_LENGTH characters plus trailing zero-byte

Return Value

Error code

Comments

This function reserves endpoint 0 of the resp. device for the user driver that calls it before using the endpoint and it releases it again afterwards.
Note that this function may take up to 2000 ms to complete, because it waits that long for data to arrive from the device.
This function must not be called from within the callback-function.

RTOS API

This library function uses a dynamic link to reach the function USB_SERVICE_HOST_GET_STRING offered by RTOS USB Software Interrupt.

Supported since or modified in @CHIP-RTOS version

    SC12SC13SC11SC1x3
    n/an/an/aV1.06

Supported by @CHIP-RTOS C Library since version

    CLIB
    V2.05

This API List
List of C Libraries
@CHIP-RTOS Main Index


End of document