Writes formatted data to the file begining at the current file position.
After the operation is completed, the current file position is incremented by the number of bytes actually written. The formatted data written is a UTF-8 string.
- Parameters
-
pFmt | [ in ] The P6ARG format template used to render the string. |
pArgs | [ in ] A pointer to an array of P6ARG structures that have been initialized withthe argument information. If this is NULL, cArgs must be zero and pFmt will be written to the file directly. |
cArgs | [ in ] An P6UINT32 containing the number of elements in the pArgs array or zero if pArgs is NULL. |
pcBytesWritten | [ out ] The address of a P6SIZE containing the number of bytes sucessfully written to the file or NULL if this information is not needed. |
- Returns
Success | P6R::eOk | |
Failure | P6R::eNotInitialized | The initialize() was not called successfully before calling this method. |
P6R::eInvalidArg | pFmt and/or pArgs was NULL, cArg was zero |
P6R::eDeviceFull | The output device (disk) is full. The write could not complete. |
P6R::eNoMemory | There was not enough memory available to complete the operation. |
P6R::eFormatError | The format string was not valid. |
P6R::eEndOfRecord | A position was specified in the format string that would cause a read past the end of the argument array that was passed in. |
P6R::eNotFound | The specified format string contains replacements but no arguments were supplied. |