A map message is a message whose body comprises a set of name-value pairs, where each value has an associated data type.
xms::PropertyContext | +----xms::Message | +----xms::MapMessage
When an application gets the value of name-value pair, the value can be converted by XMS into another data type. For more information about this form of implicit conversion, see Map messages.
Method | Description |
---|---|
getBoolean | Get the boolean value identified by name from the body of the map message. |
getByte | Get the byte identified by name from the body of the map message. |
getBytes | Get the array of bytes identified by name from the body of the map message. |
getChar | Get the character identified by name from the body of the map message. |
getDouble | Get the double precision floating point number identified by name from the body of the map message. |
getFloat | Get the floating point number identified by name from the body of the map message. |
getInt | Get the integer identified by name from the body of the map message. |
getLong | Get the long integer identified by name from the body of the map message. |
getMap | Get a list of the name-value pairs in the body of the map message. |
getObject | Get the value of a name-value pair, and its data type, from the body of the map message. |
getShort | Get the short integer identified by name from the body of the map message. |
getString | Get the string identified by name from the body of the map message. |
itemExists | Check whether the body of the map message contains a name-value pair with the specified name. |
setBoolean | Set a boolean value in the body of the map message. |
setByte | Set a byte in the body of the map message. |
setBytes | Set an array of bytes in the body of the map message. |
setChar | Set a 2-byte character in the body of the map message. |
setDouble | Set a double precision floating point number in the body of the map message. |
setFloat | Set a floating point number in the body of the map message. |
setInt | Set an integer in the body of the map message. |
setLong | Set a long integer in the body of the map message. |
setObject | Set a value, with a specified data type, in the body of the map message. |
setShort | Set a short integer in the body of the map message. |
setString | Set a string in the body of the map message. |
xmsBOOL getBoolean(const String & name) const;
Get the boolean value identified by name from the body of the map message.
xmsSBYTE getByte(const String & name) const;
Get the byte identified by name from the body of the map message.
xmsINT getBytes(const String & name, xmsSBYTE *buffer, const xmsINT bufferLength, xmsINT *actualLength) const;
Get the array of bytes identified by name from the body of the map message.
For more information about how to use this method, see C++ methods that return a byte array.
xmsCHAR16 getChar(const String & name) const;
Get the character identified by name from the body of the map message.
xmsDOUBLE getDouble(const String & name) const;
Get the double precision floating point number identified by name from the body of the map message.
xmsFLOAT getFloat(const String & name) const;
Get the floating point number identified by name from the body of the map message.
xmsINT getInt(const String & name) const;
Get the integer identified by name from the body of the map message.
xmsLONG getLong(const String & name) const;
Get the long integer identified by name from the body of the map message.
Iterator getMap() const;
Get a list of the name-value pairs in the body of the map message.
The method returns an iterator that encapsulates a list of Property objects, where each Property object encapsulates a name-value pair. The application can then use the iterator to access each name-value pair in turn.
xmsOBJECT_TYPE getObject(const String & name, xmsSBYTE *buffer, const xmsINT bufferLength, xmsINT *actualLength) const;
Get the value of a name-value pair, and its data type, from the body of the map message. The name-value pair is identified by name.
For more information about how to use this method, see C++ methods that return a byte array.
xmsSHORT getShort(const String & name) const;
Get the short integer identified by name from the body of the map message.
String getString(const String & name) const;
Get the string identified by name from the body of the map message.
xmsBOOL itemExists(const String & name) const;
Check whether the body of the map message contains a name-value pair with the specified name.
xmsVOID setBoolean(const String & name, const xmsBOOL value);
Set a boolean value in the body of the map message.
xmsVOID setByte(const String & name, const xmsSBYTE value);
Set a byte in the body of the map message.
xmsVOID setBytes(const String & name, const xmsSBYTE *value, const xmsINT length);
Set an array of bytes in the body of the map message.
xmsVOID setChar(const String & name, const xmsCHAR16 value);
Set a 2-byte character in the body of the map message.
xmsVOID setDouble(const String & name, const xmsDOUBLE value);
Set a double precision floating point number in the body of the map message.
xmsVOID setFloat(const String & name, const xmsFLOAT value);
Set a floating point number in the body of the map message.
xmsVOID setInt(const String & name, const xmsINT value);
Set an integer in the body of the map message.
xmsVOID setLong(const String & name, const xmsLONG value);
Set a long integer in the body of the map message.
xmsVOID setObject(const String & name, const xmsOBJECT_TYPE objectType, const xmsSBYTE *value, const xmsINT length);
Set a value, with a specified data type, in the body of the map message.
xmsVOID setShort(const String & name, const xmsSHORT value);
Set a short integer in the body of the map message.
xmsVOID setString(const String & name, const String value);
Set a string in the body of the map message.