A map message is a message whose body comprises a set of name-value pairs, where each value has an associated data type.
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.
Function | Description |
---|---|
xmsMapMsgGetBoolean | Get the boolean value identified by name from the body of the map message. |
xmsMapMsgGetByte | Get the byte identified by name from the body of the map message. |
xmsMapMsgGetBytes | Get the array of bytes identified by name from the body of the map message. |
xmsMapMsgGetBytesByRef | Get a pointer to an array of bytes in the body of the map message and get the length of the array. |
xmsMapMsgGetChar | Get the character identified by name from the body of the map message. |
xmsMapMsgGetDouble | Get the double precision floating point number identified by name from the body of the map message. |
xmsMapMsgGetFloat | Get the floating point number identified by name from the body of the map message. |
xmsMapMsgGetInt | Get the integer identified by name from the body of the map message. |
xmsMapMsgGetLong | Get the long integer identified by name from the body of the map message. |
xmsMapMsgGetMap | Get a list of the name-value pairs in the body of the map message. |
xmsMapMsgGetObject | Get the value of a name-value pair, and its data type, from the body of the map message. |
xmsMapMsgGetShort | Get the short integer identified by name from the body of the map message. |
xmsMapMsgGetString | Get the string identified by name from the body of the map message. |
xmsMapMsgGetStringByRef | Get a pointer to the string identified by name and get the length of the string. |
xmsMapMsgItemExists | Check whether the body of the map message contains a name-value pair with the specified name. |
xmsMapMsgSetBoolean | Set a boolean value in the body of the map message. |
xmsMapMsgSetByte | Set a byte in the body of the map message. |
xmsMapMsgSetBytes | Set an array of bytes in the body of the map message. |
xmsMapMsgSetChar | Set a 2-byte character in the body of the map message. |
xmsMapMsgSetDouble | Set a double precision floating point number in the body of the map message. |
xmsMapMsgSetFloat | Set a floating point number in the body of the map message. |
xmsMapMsgSetInt | Set an integer in the body of the map message. |
xmsMapMsgSetLong | Set a long integer in the body of the map message. |
xmsMapMsgSetObject | Set a value, with a specified data type, in the body of the map message. |
xmsMapMsgSetShort | Set a short integer in the body of the map message. |
xmsMapMsgSetString | Set a string in the body of the map message. |
xmsRC xmsMapMsgGetBoolean(xmsHMsg message, xmsCHAR *name, xmsBOOL *value, xmsHErrorBlock errorBlock);
Get the boolean value identified by name from the body of the map message.
xmsRC xmsMapMsgGetByte(xmsHMsg message, xmsCHAR *name, xmsSBYTE *value, xmsHErrorBlock errorBlock);
Get the byte identified by name from the body of the map message.
xmsRC xmsMapMsgGetBytes(xmsHMsg message, xmsCHAR *name, xmsSBYTE *buffer, xmsINT bufferLength, xmsINT *actualLength, xmsHErrorBlock errorBlock);
Get the array of bytes identified by name from the body of the map message.
For more information about how to use this function, see C functions that return a byte array by value.
xmsRC xmsMapMsgGetBytesByRef(xmsHMsg message, xmsCHAR *name, xmsSBYTE **array, xmsINT *length, xmsHErrorBlock errorBlock);
Get a pointer to an array of bytes in the body of the map message and get the length of the array. The array of bytes is identified by name.
For more information about how to use this function, see C functions that return a string or byte array by reference.
xmsRC xmsMapMsgGetChar(xmsHMsg message, xmsCHAR *name, xmsCHAR16 *value, xmsHErrorBlock errorBlock);
Get the character identified by name from the body of the map message.
xmsRC xmsMapMsgGetDouble(xmsHMsg message, xmsCHAR *name, xmsDOUBLE *value, xmsHErrorBlock errorBlock);
Get the double precision floating point number identified by name from the body of the map message.
xmsRC xmsMapMsgGetFloat(xmsHMsg message, xmsCHAR *name, xmsFLOAT *value, xmsHErrorBlock errorBlock);
Get the floating point number identified by name from the body of the map message.
xmsRC xmsMapMsgGetInt(xmsHMsg message, xmsCHAR *name, xmsINT *value, xmsHErrorBlock errorBlock);
Get the integer identified by name from the body of the map message.
xmsRC xmsMapMsgGetLong(xmsHMsg message, xmsCHAR *name, xmsLONG *value, xmsHErrorBlock errorBlock);
Get the long integer identified by name from the body of the map message.
xmsRC xmsMapMsgGetMap(xmsHMsg message, xmsHIterator *iterator, xmsHErrorBlock errorBlock);
Get a list of the name-value pairs in the body of the map message.
The function 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.
xmsRC xmsMapMsgGetObject(xmsHMsg message, xmsCHAR *name, xmsSBYTE *buffer, xmsINT bufferLength, xmsINT *actualLength, xmsOBJECT_TYPE *objectType, xmsHErrorBlock errorBlock);
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 function, see C functions that return a byte array by value.
xmsRC xmsMapMsgGetShort(xmsHMsg message, xmsCHAR *name, xmsSHORT *value, xmsHErrorBlock errorBlock);
Get the short integer identified by name from the body of the map message.
xmsRC xmsMapMsgGetString(xmsHMsg message, xmsCHAR *name, xmsCHAR *buffer, xmsINT bufferLength, xmsINT *actualLength, xmsHErrorBlock errorBlock);
Get the string identified by name from the body of the map message.
For more information about how to use this function, see C functions that return a string by value.
xmsRC xmsMapMsgGetStringByRef(xmsHMsg message, xmsCHAR *name, xmsCHAR **string, xmsINT *length, xmsHErrorBlock errorBlock);
Get a pointer to the string identified by name and get the length of the string.
For more information about how to use this function, see C functions that return a string or byte array by reference.
xmsRC xmsMapMsgItemExists(xmsHMsg message, xmsCHAR *name, xmsBOOL *pairExists, xmsHErrorBlock errorBlock);
Check whether the body of the map message contains a name-value pair with the specified name.
xmsRC xmsMapMsgSetBoolean(xmsHMsg message, xmsCHAR *name, xmsBOOL value, xmsHErrorBlock errorBlock);
Set a boolean value in the body of the map message.
xmsRC xmsMapMsgSetByte(xmsHMsg message, xmsCHAR *name, xmsSBYTE value, xmsHErrorBlock errorBlock);
Set a byte in the body of the map message.
xmsRC xmsMapMsgSetBytes(xmsHMsg message, xmsCHAR *name, xmsSBYTE *value, xmsINT length, xmsHErrorBlock errorBlock);
Set an array of bytes in the body of the map message.
xmsRC xmsMapMsgSetChar(xmsHMsg message, xmsCHAR *name, xmsCHAR16 value, xmsHErrorBlock errorBlock);
Set a 2-byte character in the body of the map message.
xmsRC xmsMapMsgSetDouble(xmsHMsg message, xmsCHAR *name, xmsDOUBLE value, xmsHErrorBlock errorBlock);
Set a double precision floating point number in the body of the map message.
xmsRC xmsMapMsgSetFloat(xmsHMsg message, xmsCHAR *name, xmsFLOAT value, xmsHErrorBlock errorBlock);
Set a floating point number in the body of the map message.
xmsRC xmsMapMsgSetInt(xmsHMsg message, xmsCHAR *name, xmsINT value, xmsHErrorBlock errorBlock);
Set an integer in the body of the map message.
xmsRC xmsMapMsgSetLong(xmsHMsg message, xmsCHAR *name, xmsLONG value, xmsHErrorBlock errorBlock);
Set a long integer in the body of the map message.
xmsRC xmsMapMsgSetObject(xmsHMsg message, xmsCHAR *name, xmsSBYTE *value, xmsINT length, xmsOBJECT_TYPE objectType, xmsHErrorBlock errorBlock);
Set a value, with a specified data type, in the body of the map message.
xmsRC xmsMapMsgSetShort(xmsHMsg message, xmsCHAR *name, xmsSHORT value, xmsHErrorBlock errorBlock);
Set a short integer in the body of the map message.
xmsRC xmsMapMsgSetString(xmsHMsg message, xmsCHAR *name, xmsCHAR *value, xmsINT length, xmsHErrorBlock errorBlock);
Set a string in the body of the map message.