|
|
| xplDevice * Create |
( |
string const & |
_vendorId, |
|
|
string const & |
_deviceId, |
|
|
string const & |
_version, |
|
|
bool const |
_bConfigInRegistry, |
|
|
xplComms * |
_pComms |
|
) |
[static] |
|
|
|
Create an xplDevice.
The xplDevice provides the all of the core xPL functionality for an application. - Parameters:
-
| _vendorId | your vendor ID. A string containing the vendor name of the application author. Vendor names are assigned on a first-come, first-served basis by the xPL project organsisers. Vendor IDs are a maximum of 8 characters in length. To request a vendor name, post a message to the xPL Forums |
| _deviceId | your device ID. A string containing a name related to the device that this application supports, usually the same as the application name. Device IDs are a maximum of 8 characters in length. |
| _version | version number of the application. This should be in the form major.minor.revision, for example - 4.1.12, and should match the version number used in the installer properties. If the version does not match the value stored in the registry or config file, the application will enter config mode, requiring the user to review any new values that have been added or changed since the last revision. |
| _bConfigInRegistry | where to store the application configuration. If true, config items are read from the registry. If false, those values are taken from a configuration file instead. |
| _pComms | communications object to use when sending/receiving xPL messages. For normal ethernet communications, create an xplUDP object and pass it in here. |
- Returns:
- A pointer to a new xplDevice. If an error occured during creation, the method returns NULL instead.
- See also:
- Destroy, xplComms, xplUDP
|
|
