- Interface:
-
xmsRC xmsTextMsgGetText(xmsHMsg message,
xmsCHAR *buffer,
xmsINT bufferLength,
xmsINT *actualLength,
xmsHErrorBlock errorBlock);
Get the string that forms
the body of the text message. If required, XMS converts
the characters in the string into the local code page.
For more information
about how to use this function, see C functions that return a string by value.
- Parameters:
-
- message (input)
- The handle for the message.
- buffer (output)
- The buffer to contain the string. If data conversion is required, this
is the string after conversion.
- bufferLength (input)
- The length of the buffer in bytes. If you specify XMSC_QUERY_SIZE instead,
the string is not returned, but its length is returned in the actualLength
parameter.
- actualLength (output)
- The length of the string in bytes. If data conversion is required, this
is the length of the string after conversion. If you specify a null pointer
on input, the length is not returned.
- errorBlock (input)
- The handle for an error block or a null handle.
- Exceptions:
-
- XMS_X_GENERAL_EXCEPTION
- XMS_X_MESSAGE_NOT_READABLE_EXCEPTION
- XMS_X_MESSAGE_EOF_EXCEPTION
Notes: - If the buffer is not large enough to store the whole string, XMS returns
the string truncated to the length of the buffer, sets the actualLength parameter
to the actual length of the string, and returns an error.
- If any other error occurs while attempting to get the string, XMS reports
the error but does not set the actualLength parameter.