Changeset 34017 in vbox for trunk/include/iprt

Timestamp:

Nov 12, 2010 12:30:21 AM (14 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

67682

Message:

iprt/fs.h: Added note to RTFMODE defines about being used in a binary interface (shared folders).

File:

• trunk/include/iprt/fs.h (modified) (1 diff)

trunk/include/iprt/fs.h

@@ -42 +42 @@
 /** @name Filesystem Object Mode Flags.
  *
- * There are two sets of flags: the unix mode flags and the dos
- * attributes.
+ * There are two sets of flags: the unix mode flags and the dos attributes.
  *
  * APIs returning mode flags will provide both sets.
  *
- * When specifying mode flags to any API at least one of
- * them must be given. If one set is missing the API will
- * synthesize it from the one given if it requires it.
- *
- * Both sets match their x86 ABIs, the DOS/NT one is simply shifted
- * up 16 bits. The DOS/NT range is bits 16 to 31 inclusively. The
- * Unix range is bits 0 to 15 (inclusively).
+ * When specifying mode flags to any API at least one of them must be given. If
+ * one set is missing the API will synthesize it from the one given if it
+ * requires it.
+ *
+ * Both sets match their x86 ABIs, the DOS/NT one is simply shifted up 16 bits.
+ * The DOS/NT range is bits 16 to 31 inclusively. The Unix range is bits 0 to 15
+ * (inclusively).
+ *
+ * @remarks These constants have been comitted to a binary format and must not
+ *          be changed in any incompatible ways.
  *
  * @{