PhidgetDictionaryMBS.addKey(key as string, value as string, persistent as integer) as integer
method, Phidget, MBS USB Plugin (Phidgets), class PhidgetDictionaryMBS, Console safe, Plugin version: 7.7, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Adds a new key to the Dictionary, or modifies the value of an existing key.
Notes:
The key can only contain numbers, letters, ‘/’, ‘.’, ‘-‘, ‘_’, and must begin with a letter, ‘_’ or ‘/’.
The value can contain any value.
The persistent value controls whether a key will stay in the dictionary after the client that created it disconnects. If persistent == 0, the key is removed when the connection closes. Otherwise the key remains in the dictionary until it is explicitly removed.

Lasterror is set.

class PhidgetDictionaryMBS
class, Phidget, MBS USB Plugin (Phidgets), class PhidgetDictionaryMBS, Console safe, Plugin version: 7.7, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: The Phidget Dictionary is a service provided by the Phidget Webservice.
Notes:
The Webservice maintains a centralized dictionary of key-value pairs that can be accessed and changed from any number of clients through the CPhidgetDictionary interface available in phidget21.

Note that the Webservice uses this dictionary to control access to Phidgets through the openRemote and openRemoteIP interfaces, and as such, you should never add or modify a key that starts with /PSK/ or /PCK/, unless you want to explicitly modify Phidget specific data – and this is highly discouraged, as it’s very easy to break things. Listening to these keys is fine if so desired.

The intended use for the dictionary is as a central repository for communication and persistent storage of data between several client applications. As an example - a higher level interface exposed by one application – which controls the Phidgets, for others to access – rather then every client talking directly to the Phidgets themselves.

The dictionary makes use of extended regular expressions for key matching. See the end of this document for the rules of regular expressions.

See the Phidget manuals for help on regular expressions.

PhidgetDictionaryMBS.Close
method, Phidget, MBS USB Plugin (Phidgets), class PhidgetDictionaryMBS, Console safe, Plugin version: 7.7, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Closes the file handles for this device.
Notes:
You should always call this when finished with a Dictionary.
Lasterror is set.

PhidgetDictionaryMBS.Constructor
method, Phidget, MBS USB Plugin (Phidgets), class PhidgetDictionaryMBS, Console safe, Plugin version: 8.2, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: A dummy constructor doing nothing.

PhidgetDictionaryMBS.Constructor(pattern as string)
method, Phidget, MBS USB Plugin (Phidgets), class PhidgetDictionaryMBS, Console safe, Plugin version: 7.7, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: The constructor.
Notes:
The Lasterror property is set.
Pattern is a regular expression that matches the keys you want to listen for in the keychange event.

PhidgetDictionaryMBS.Error(errorCode as integer, errorDescription as string)
event, Phidget, MBS USB Plugin (Phidgets), class PhidgetDictionaryMBS, Plugin version: 7.7, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: This error event is used for reporting asynchronous errors – mostly related to opening remote Phidgets.
Notes:
With plugin version 8.5 and newer this event is executed on the main thread of your application to avoid crashes with REALbasic. Events are buffered until you the main thread has time available.
Older plugins execute the event on the thread where the event was created which may lead into problems described in the ThreadMBS class documentation.

PhidgetDictionaryMBS.GetDeviceStatus as integer
method, Phidget, MBS USB Plugin (Phidgets), class PhidgetDictionaryMBS, Console safe, Plugin version: 7.7, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Returns an integer indicating the status of the device.
Notes:
Returns:
PHIDGET_ATTACHED 0x1
PHIDGET_NOTATTACHED 0x0

Lasterror is set.

PhidgetDictionaryMBS.getKey(key as string, value as string, valsize as integer) as integer
method, Phidget, MBS USB Plugin (Phidgets), class PhidgetDictionaryMBS, Console safe, Plugin version: 7.7, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: This method is not yet implemented and will return EPHIDGET_UNSUPPORTED.
Notes: The Lasterror property is set.

PhidgetDictionaryMBS.getServerAddress(byref port as integer) as string
method, Phidget, MBS USB Plugin (Phidgets), class PhidgetDictionaryMBS, Console safe, Plugin version: 8.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Gets the address and port.
Notes: The Lasterror property is set.

PhidgetDictionaryMBS.getServerID as string
method, Phidget, MBS USB Plugin (Phidgets), class PhidgetDictionaryMBS, Console safe, Plugin version: 8.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Gets the server ID.
Notes: The Lasterror property is set.

PhidgetDictionaryMBS.GetServerStatus as integer
method, Phidget, MBS USB Plugin (Phidgets), class PhidgetDictionaryMBS, Console safe, Plugin version: 7.7, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Returns an integer indicating the connection status of a Webservice.
Notes:
Returns one of the following values:
1 CONNECTED
0 NOTCONNECTED

Lasterror is set.

PhidgetDictionaryMBS.Handle as Integer
property, Phidget, MBS USB Plugin (Phidgets), class PhidgetDictionaryMBS, Console safe, Plugin version: 7.7, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: The internal used CPhidgetDictionaryHandle.
Notes: (Read and Write property)

PhidgetDictionaryMBS.KeyChanged(key as string, value as string, reason as integer)
event, Phidget, MBS USB Plugin (Phidgets), class PhidgetDictionaryMBS, Plugin version: 7.7, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: These event will be called on key add, remove, and change.
Notes:
The Lasterror property is set.
It will also fire once to give an initial key value as soon as it is registered, if the key already exists.

With plugin version 8.5 and newer this event is executed on the main thread of your application to avoid crashes with REALbasic. Events are buffered until you the main thread has time available.
Older plugins execute the event on the thread where the event was created which may lead into problems described in the ThreadMBS class documentation.

Reason values:

PHIDGET_DICTIONARY_VALUE_CHANGED	1
PHIDGET_DICTIONARY_ENTRY_ADDED	2
PHIDGET_DICTIONARY_ENTRY_REMOVING	3
PHIDGET_DICTIONARY_CURRENT_VALUE	4

PhidgetDictionaryMBS.Lasterror as Integer
property, Phidget, MBS USB Plugin (Phidgets), class PhidgetDictionaryMBS, Console safe, Plugin version: 7.7, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: The last error code.
Notes: (Read and Write property)

PhidgetDictionaryMBS.openRemote(serverID as string, password as string) as integer
method, Phidget, MBS USB Plugin (Phidgets), class PhidgetDictionaryMBS, Console safe, Plugin version: 7.7, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: This method is not yet implemented and will return EPHIDGET_UNSUPPORTED.
Notes: The Lasterror property is set.

PhidgetDictionaryMBS.openRemoteIP(addr as string, port as integer, password as string) as integer
method, Phidget, MBS USB Plugin (Phidgets), class PhidgetDictionaryMBS, Console safe, Plugin version: 7.7, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Opens a connection to a remote Phidget Dictionary.
Notes:
OpenRemoteIP will block until it connects to the server, which means that when it returns with EPHIDGET_OK, this means that the connection is active. If the server is unavailable, this will return an error code.

If the connection to a webservice is disrupted while in use, an error event will be thrown, and it is recommended that an error event listener be registered for this reason.

Lasterror is set.

PhidgetDictionaryMBS.removeKey(pattern as string) as integer
method, Phidget, MBS USB Plugin (Phidgets), class PhidgetDictionaryMBS, Console safe, Plugin version: 7.7, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Removes a key, or set of keys, from the Dictionary.
Notes:
The key name is a regular expressions pattern, and so care must be taken to only have it match the specific keys you want to remove.
Lasterror is set.

PhidgetDictionaryMBS.ServerConnect
event, Phidget, MBS USB Plugin (Phidgets), class PhidgetDictionaryMBS, Plugin version: 8.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: This event is called when a connection to the sever has been made.
Notes:
With plugin version 8.5 and newer this event is executed on the main thread of your application to avoid crashes with REALbasic. Events are buffered until you the main thread has time available.
Older plugins execute the event on the thread where the event was created which may lead into problems described in the ThreadMBS class documentation.

PhidgetDictionaryMBS.ServerDisconnect
event, Phidget, MBS USB Plugin (Phidgets), class PhidgetDictionaryMBS, Plugin version: 8.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: This event is called when a connection to the server has been lost.
Notes:
With plugin version 8.5 and newer this event is executed on the main thread of your application to avoid crashes with REALbasic. Events are buffered until you the main thread has time available.
Older plugins execute the event on the thread where the event was created which may lead into problems described in the ThreadMBS class documentation.