XFcHardwareId class Reference

Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members File Members

# XFcHardwareId Class Reference

Static methods to uniquely identify the host device. More...

List of all members.

## Static Public Member Functions

XFCIMPORT UINT32 | queryAvailableIds ()
| Queries the available ids on this platform.
XFCIMPORT CHAR * | readId (UINT32 aIdType)
| Returns device identification string.

## Detailed Description

Static methods to uniquely identify the host device.

The XFcHardwareId class relies on the underlaying operating system for its functionality. All platforms do not support all kinds of ids, and ids may look different in different platforms. All ids are converted to character strings for convenience.

## Member Function Documentation

XFCIMPORT UINT32 XFcHardwareId::queryAvailableIds | ( |  | ) | `[static]`

Queries the available ids on this platform.

Returns:
  combined value of available ids' flags, see XFCHARDWAREIDFLAGS.

See also:
  XFCHARDWAREIDFLAGS

XFCIMPORT CHAR* XFcHardwareId::readId | ( | UINT32 | aIdType | ) | `[static]`

Returns device identification string.

Parameters:

  aIdType | id type to request, see XFCHARDWAREIDFLAGS.

Returns:
  string containing a new copy of the requested id, or NULL if the request failed. Application should delete[] the returned string when it is not needed anymore.

Note:
  On desktop windows platform you can create 'xfchi_userid.txt', 'xfchi_mediaid.txt' and 'xfchi_deviceid.txt' to override the contents of the ids.

See also:
  XFCHARDWAREIDFLAGS

|  | X-Forge Documentation Confidential Copyright © 2002-2003 Fathammer |  | Documentation generated with doxygen by Dimitri van Heesch