Function | Description |
---|---|
xmsBytesMsgGetBodyLength | Get the length of the body of the message when the body of the message is read-only. |
xmsBytesMsgReadBoolean | Read a boolean value from the bytes message stream. |
xmsBytesMsgReadByte | Read the next byte from the bytes message stream as a signed 8-bit integer. |
xmsBytesMsgReadBytes | Read an array of bytes from the bytes message stream starting from the current position of the cursor. |
xmsBytesMsgReadBytesByRef | Get a pointer to the start of the bytes message stream and get the length of the stream. |
xmsBytesMsgReadChar | Read the next 2 bytes from the bytes message stream as a character. |
xmsBytesMsgReadDouble | Read the next 8 bytes from the bytes message stream as a double precision floating point number. |
xmsBytesMsgReadFloat | Read the next 4 bytes from the bytes message stream as a floating point number. |
xmsBytesMsgReadInt | Read the next 4 bytes from the bytes message stream as a signed 32-bit integer. |
xmsBytesMsgReadLong | Read the next 8 bytes from the bytes message stream as a signed 64-bit integer. |
xmsBytesMsgReadShort | Read the next 2 bytes from the bytes message stream as a signed 16-bit integer. |
xmsBytesMsgReadUnsignedByte | Read the next byte from the bytes message stream as an unsigned 8-bit integer. |
xmsBytesMsgReadUnsignedShort | Read the next 2 bytes from the bytes message stream as an unsigned 16-bit integer. |
xmsBytesMsgReadUTF | Read a string, encoded in UTF-8, from the bytes message stream. |
xmsBytesMsgReset | Put the body of the message into read-only mode and reposition the cursor at the beginning of the bytes message stream. |
xmsBytesMsgWriteBoolean | Write a boolean value to the bytes message stream. |
xmsBytesMsgWriteByte | Write a byte to the bytes message stream. |
xmsBytesMsgWriteBytes | Write an array of bytes to the bytes message stream. |
xmsBytesMsgWriteChar | Write a character to the bytes message stream as 2 bytes, high order byte first. |
xmsBytesMsgWriteDouble | Convert a double precision floating point number to a long integer and write the long integer to the bytes message stream as 8 bytes, high order byte first. |
xmsBytesMsgWriteFloat | Convert a floating point number to an integer and write the integer to the bytes message stream as 4 bytes, high order byte first. |
xmsBytesMsgWriteInt | Write an integer to the bytes message stream as 4 bytes, high order byte first. |
xmsBytesMsgWriteLong | Write a long integer to the bytes message stream as 8 bytes, high order byte first. |
xmsBytesMsgWriteShort | Write a short integer to the bytes message stream as 2 bytes, high order byte first. |
xmsBytesMsgWriteUTF | Write a string, encoded in UTF-8, to the bytes message stream. |
xmsRC xmsBytesMsgGetBodyLength(xmsHMsg message, xmsLONG *bodyLength, xmsHErrorBlock errorBlock);
Get the length of the body of the message when the body of the message is read-only.
xmsRC xmsBytesMsgReadBoolean(xmsHMsg message, xmsBOOL *value, xmsHErrorBlock errorBlock);
Read a boolean value from the bytes message stream.
xmsRC xmsBytesMsgReadByte(xmsHMsg message, xmsSBYTE *value, xmsHErrorBlock errorBlock);
Read the next byte from the bytes message stream as a signed 8-bit integer.
xmsRC xmsBytesMsgReadBytes(xmsHMsg message, xmsSBYTE *buffer, xmsINT bufferLength, xmsINT *returnedLength, xmsHErrorBlock errorBlock);
Read an array of bytes from the bytes message stream starting from the current position of the cursor.
If you specify a null pointer on input, the function skips over the bytes without reading them. If the number of bytes remaining to be read from the stream before the call is greater than or equal to the length of the buffer, the number of bytes skipped is equal to the length of the buffer. Otherwise, all the remaining bytes are skipped.
If you specify a null pointer on input, the function returns no value.
xmsRC xmsBytesMsgReadBytesByRef(xmsHMsg message, xmsSBYTE **stream, xmsINT *length, xmsHErrorBlock errorBlock);
Get a pointer to the start of the bytes message stream and get the length of the stream.
For more information about how to use this function, see C functions that return a string or byte array by reference.
xmsRC xmsBytesMsgReadChar(xmsHMsg message, xmsCHAR16 *value, xmsHErrorBlock errorBlock);
Read the next 2 bytes from the bytes message stream as a character.
xmsRC xmsBytesMsgReadDouble(xmsHMsg message, xmsDOUBLE *value, xmsHErrorBlock errorBlock);
Read the next 8 bytes from the bytes message stream as a double precision floating point number.
xmsRC xmsBytesMsgReadFloat(xmsHMsg message, xmsFLOAT *value, xmsHErrorBlock errorBlock);
Read the next 4 bytes from the bytes message stream as a floating point number.
xmsRC xmsBytesMsgReadInt(xmsHMsg message, xmsINT *value, xmsHErrorBlock errorBlock);
Read the next 4 bytes from the bytes message stream as a signed 32-bit integer.
xmsRC xmsBytesMsgReadLong(xmsHMsg message, xmsLONG *value, xmsHErrorBlock errorBlock);
Read the next 8 bytes from the bytes message stream as a signed 64-bit integer.
xmsRC xmsBytesMsgReadShort(xmsHMsg message, xmsSHORT *value, xmsHErrorBlock errorBlock);
Read the next 2 bytes from the bytes message stream as a signed 16-bit integer.
xmsRC xmsBytesMsgReadUnsignedByte(xmsHMsg message, xmsBYTE *value, xmsHErrorBlock errorBlock);
Read the next byte from the bytes message stream as an unsigned 8-bit integer.
xmsRC xmsBytesMsgReadUnsignedShort(xmsHMsg message, xmsUSHORT *value, xmsHErrorBlock errorBlock);
Read the next 2 bytes from the bytes message stream as an unsigned 16-bit integer.
xmsRC xmsBytesMsgReadUTF(xmsHMsg message, xmsCHAR *buffer, xmsINT bufferLength, xmsINT *actualLength, xmsHErrorBlock errorBlock);
Read a string, encoded in UTF-8, from the bytes message stream. If required, XMS converts the characters in the string from UTF-8 into the local code page.
For more information about how to use this function, see C functions that return a string by value.
If you specify XMSC_QUERY_SIZE, the string is not returned, but its length is returned in the actualLength parameter, and the cursor is not advanced.
If you specify XMSC_SKIP, the function skips over the string without reading it.
xmsRC xmsBytesMsgReset(xmsHMsg message, xmsHErrorBlock errorBlock);
Put the body of the message into read-only mode and reposition the cursor at the beginning of the bytes message stream.
xmsRC xmsBytesMsgWriteBoolean(xmsHMsg message, xmsBOOL value, xmsHErrorBlock errorBlock);
Write a boolean value to the bytes message stream.
xmsRC xmsBytesMsgWriteByte(xmsHMsg message, xmsSBYTE value, xmsHErrorBlock errorBlock);
Write a byte to the bytes message stream.
xmsRC xmsBytesMsgWriteBytes(xmsHMsg message, xmsSBYTE *value, xmsINT length, xmsHErrorBlock errorBlock);
Write an array of bytes to the bytes message stream.
xmsRC xmsBytesMsgWriteChar(xmsHMsg message, xmsCHAR16 value, xmsHErrorBlock errorBlock);
Write a character to the bytes message stream as 2 bytes, high order byte first.
xmsRC xmsBytesMsgWriteDouble(xmsHMsg message, xmsDOUBLE value, xmsHErrorBlock errorBlock);
Convert a double precision floating point number to a long integer and write the long integer to the bytes message stream as 8 bytes, high order byte first.
xmsRC xmsBytesMsgWriteFloat(xmsHMsg message, xmsFLOAT value, xmsHErrorBlock errorBlock);
Convert a floating point number to an integer and write the integer to the bytes message stream as 4 bytes, high order byte first.
xmsRC xmsBytesMsgWriteInt(xmsHMsg message, xmsINT value, xmsHErrorBlock errorBlock);
Write an integer to the bytes message stream as 4 bytes, high order byte first.
xmsRC xmsBytesMsgWriteLong(xmsHMsg message, xmsLONG value, xmsHErrorBlock errorBlock);
Write a long integer to the bytes message stream as 8 bytes, high order byte first.
xmsRC xmsBytesMsgWriteShort(xmsHMsg message, xmsSHORT value, xmsHErrorBlock errorBlock);
Write a short integer to the bytes message stream as 2 bytes, high order byte first.
xmsRC xmsBytesMsgWriteUTF(xmsHMsg message, xmsCHAR *value, xmsINT length, xmsHErrorBlock errorBlock);
Write a string, encoded in UTF-8, to the bytes message stream. If required, XMS converts the characters in the string from the local code page into UTF-8.