Table of Contents Index NMS Glossary Previous Page Next Page (Page 41 of 41 in this chapter) Version


vceWriteMessageText

Description

Writes the message text for a specified voice message in a VOX file.

Prototype

DWORD vceWriteMessageText ( VCEHD vh,
unsigned message,
void *buffer,
unsigned size)

vh Handle of an open VOX file.

message Any valid VOX file message number.

buffer Pointer to a buffer of data to write.

size Amount of data to write.

Return Values

Events

Details

This function stores auxiliary data for a specified message in a VOX file. Although the function name suggests that this function is used for textual data, the data can be any binary data.

Existing data for message will be replaced with the new data.

To erase message data for a specific message, set size to zero (0). buffer can be NULL in this case. To erase all message data, set message number to VCE_ALL_MESSAGES and set size to zero (0).

vceWriteMessageText does not affect the current message for the context.

Message text is intended to be fairly static. Re-writing with different size buffers can result in file fragmentation. If you want to use the message text to store dynamic information (for example, a message time stamp), use a fixed size for all writes.

See Also

vceCopyMessageText, vceReadMessageText

Example


/* Add text to a message in an open VOX file */

void myAddMessageText (VCEHD vh, unsigned message, char *text)
{
unsigned size = strlen(text) ;

vceWriteMessageText (vh, message, text, size);
}



Table of Contents Index NMS Glossary Previous Page Next Page (Page 41 of 41 in this chapter) Version


Want to send us feedback on our documentation? Email: Tech_Pubs@nmss.com
Copyright © 2001, Natural MicroSystems, Inc. All rights reserved.