Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
| en:docs:fapi:dosputmessage [2018/08/31 09:19] – created prokushev | en:docs:fapi:dosputmessage [2021/09/17 06:37] (current) – prokushev | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| + | {{page> | ||
| + | |||
| + | ====== DosPutMessage ====== | ||
| This call outputs the message in a buffer passed by a caller to the specified handle. The function formats the buffer to prevent words from wrapping if displayed to a screen. | This call outputs the message in a buffer passed by a caller to the specified handle. The function formats the buffer to prevent words from wrapping if displayed to a screen. | ||
| - | ==Syntax== | + | ===== Syntax ===== |
| - | | + | <code c> |
| + | DosPutMessage (FileHandle, | ||
| + | </ | ||
| - | ==Parameters== | + | ===== Parameters ===== |
| - | ;FileHandle (USHORT) - input : Handle of the output file or device. | + | |
| - | ;MessageLength (USHORT) - input : Length of the message to be output. | + | |
| - | ;MessageBuffer (PCHAR) - input : Address of the buffer that contains the returned message. | + | |
| + | | ||
| + | |||
| + | ===== Return Code ===== | ||
| + | |||
| + | rc ([[USHORT]]) - return | ||
| - | ==Return Code== | ||
| - | rc (USHORT) - return | ||
| Return code descriptions are: | Return code descriptions are: | ||
| - | * 0 | ||
| - | * 6 | ||
| - | * 19 ERROR_WRITE_PROTECT | ||
| - | * 321 ERROR_MR_UN_PERFORM | ||
| - | ==Remarks== | + | * 0 |
| + | * 6 | ||
| + | * 19 ERROR_WRITE_PROTECT | ||
| + | * 321 ERROR_MR_UN_PERFORM | ||
| + | |||
| + | ===== Remarks ===== | ||
| Screen width is assumed to be 80 characters. The DosPutMessage call counts a CR/LF in the 80 characters that it tries to write to the screen. If a word extends past column 78, it is put on the next line. DosPutMessage assumes the starting cursor position is column one when handling a word wrap. | Screen width is assumed to be 80 characters. The DosPutMessage call counts a CR/LF in the 80 characters that it tries to write to the screen. If a word extends past column 78, it is put on the next line. DosPutMessage assumes the starting cursor position is column one when handling a word wrap. | ||
| If the last character to be positioned on a line is a double-byte character that would be bisected, the rule above ensures that the character is not bisected. | If the last character to be positioned on a line is a double-byte character that would be bisected, the rule above ensures that the character is not bisected. | ||
| - | ==Example Code== | + | ===== Example Code ===== |
| - | ===C Binding=== | + | |
| - | <PRE> | + | ==== C Binding ==== |
| + | |||
| + | <code c> | ||
| #define INCL_DOSMISC | #define INCL_DOSMISC | ||
| Line 35: | Line 47: | ||
| USHORT | USHORT | ||
| - | </PRE> | + | </code> |
| - | ===MASM Binding=== | + | ==== MASM Binding ==== |
| - | <PRE> | + | |
| + | <code asm> | ||
| EXTRN DosPutMessage: | EXTRN DosPutMessage: | ||
| INCL_DOSMISC | INCL_DOSMISC | ||
| Line 46: | Line 59: | ||
| PUSH@ OTHER | PUSH@ OTHER | ||
| CALL | CALL | ||
| + | </ | ||
| Returns WORD | Returns WORD | ||
| - | </ | ||
| - | |||
| - | |||
| - | ====== Note ====== | + | ===== Note ===== |
| Text based on [[http:// | Text based on [[http:// | ||