Neonode zForce(TM) SDK

Classes | Typedefs | Functions
HidPipeTransport.h File Reference

Transport module to connect to devices over HID Pipe. More...

Go to the source code of this file.

## Classes
struct | HidPipeTransport
| Struct containing the HidPipeTransport information. More...

## Typedefs
typedef struct HidPipeTransport | HidPipeTransport

## Functions
DLLINTERNAL bool | HidPipeTransport_AddHidPipeTransportEntry (void)
| Internal call to add a HidPipeTransport to the list of available transports. More...

## Detailed Description

Transport module to connect to devices over HID Pipe.

Allows connections to devices using HID Pipe.

Copyright
  COPYRIGHT NOTICE: (c) 2017-2022 Neonode Technologies AB. All rights reserved.

## Typedef Documentation

## ◆ HidPipeTransport

typedef struct HidPipeTransport HidPipeTransport

See also
  struct HidPipeTransport

## Function Documentation

## ◆ HidPipeTransport_AddHidPipeTransportEntry()

DLLINTERNAL bool HidPipeTransport_AddHidPipeTransportEntry | ( | void |  | ) |

Internal call to add a HidPipeTransport to the list of available transports.

This is the method used to add a HidPipeTransport which can be used for communication.
On failure, errno is set.

- EALREADYADDED - A Transport matching the name and data frame type has already been added.
- EOUTOFMEMORY - The memory used to store Transport details has been exhausted.
- EMUTEXLOCKFAILED - We couldn't lock a mutex we need for an internal critical section. This should not happen.
- EBADMUTEX - We tried to use a mutex internally but it wasn't a valid mutex. This should not happen.
- EPARAMETERSTRINGTOOLONG - The option parameter string is longer than the MaxOptionParameterLength.

Returns
  True if the HidPipeTransport has been added.