The Platform SDK documentation uses the following document conventions.
Convention | Description |
---|---|
|
Indicates source code, structure syntax, examples, user input, and program output. |
Bold | Indicates a function, structure, macro, interface, method, data type, or other keyword in the programming interface or programming language. |
Italic | Indicates placeholders, most often function or method parameters; these placeholders represent the information that must be supplied by the implementation or the user. In addition, italics are used to highlight the first use of terms and to emphasize meaning. |
UPPERCASE | Indicates a flag, return value, or property. In addition, uppercase letters may indicate file names, registers, and terms used at the operating-system command level. |
[ ] | Indicates optional syntax items. Type only the syntax within the brackets, not the brackets themselves. |