C 6.0 HELPMAKE Example for RTF in Online Help Is Incorrect

ID Number: Q68691

1.07 | 1.07

MS-DOS | OS/2

docerr

Summary:

In the online help for the HELPMAKE utility shipped with Microsoft C

versions 6.0, 6.0a, and 6.0ax, there are several errors in the example

for making help databases with rich text format (RTF) files. Because

of these errors, HELPMAKE cannot encode the example.

The following is the RTF example from the online help. Below the

listing are the necessary corrections.

Online Help RTF Example

-----------------------

1. {rtf0

2. >> open \par

3. {\b Include:} <fcntl.h>, <io.h>, <sys\\types.h>, <sys\\stat.h>

4.

5. {\b Prototype:} int open(char *path, int flag[, int mode]);\par

6. flag: O_APPEND O_BINARY O_CREAT O_EXCL O_RDONLY\par

7. O_RDWR O_TEXT O_TRUNC O_WRONLY\par

8. (can be joined by |)\par

9. mode: S_IWRITE S_IREAD S_IREAD | S_IWRITE\par

10. \par

11. {\b Returns:} a handle if successful, or -1 if not.\par

12. errno: EACCES, EEXIST, EMFILE, ENOENT\par

13. \par

14. {\b See also:} {\u Example}{\v open.ex},\par

15. {\u Template}{\v open.tp}, access, chmod, close,

16. creat, dup, dup2, fopen, sopen, umask\par

17. }

1. Line 1 needs a backslash before "rtf". It should read:

{\rtf0

2. "\u" in lines 14 and 15 is not RTF formatting code. "\ul" is the

correct code. Line 14 should read:

{\b See also:} {\ul Example}{\v open.ex},\par

3. "\par" is needed on the end of line 15 for the formatting to be

consistent. Line 15 should read:

{\ul Template}{\v open.tp}, access, chmod, close,\par