TReportTranslator Class Reference
HID report translator
Allows a device driver to extract data items from a device report, based on the results of the report descriptor parser stage (at device connection)
generichid.lib
- Since
- S60 v5.0
Constructor & Destructor Documentation
TReportTranslator(const TDesC8 &, const CField *)
| IMPORT_C | TReportTranslator | ( | const TDesC8 & | aData, |
| | const CField * | aField |
| | ) | |
Parameters
| const TDesC8 & aData | Data to be extracted |
| const CField * aField | HID field |
Member Functions Documentation
Count()
| IMPORT_C TInt | Count | ( | ) | const |
Gets the number of controls in the field.
GetUsageId(TInt &, TInt)
Gets the usage ID at a given index in an array field. For variable fields, if the logical value of the control at the given index is non- zero, returns the usage ID of the control, otherwise returns zero.
Parameters
| TInt & aUsageId | Reference to variable to receive the usage ID. |
| TInt aIndex | Index in the array to read. |
GetValue(TInt &, TInt, TInt)
For variable fields, reads the logical value of the control with the given usage ID. For arrays, searches for the usage ID and gives the value as ETrue if found and EFalse if not.
Parameters
| TInt & aValue | Reference to variable to receive the value read from the field. |
| TInt aUsageId | Usage ID of the control to read. |
| TInt aControlOffset = 0 | Which control to read when more than one have the same usage ID. |
RawValueL(TInt)
Gets the logical value at a given index in a field. Leaves if an error occurs.
Parameters
| TInt aIndex | Index in the field to read. |
UsageIdL(TInt)
Alternate version of the above method for convenience. Returns the usage ID directly and leaves if an error occurs.
Parameters
| TInt aIndex | Index in the array to read. |
ValueL(TInt, TInt)
| IMPORT_C TInt | ValueL | ( | TInt | aUsageId, |
| | TInt | aControlOffset = 0 |
| | ) | const |
Alternate version of the above method for convenience. Returns the value read directly and leaves if an error occurs.
Parameters
| TInt aUsageId | Usage ID of the control to read. |
| TInt aControlOffset = 0 | Which control to read when more than one have the same usage ID. |
Member Data Documentation
Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights
reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License
v1.0.