Differences

This shows you the differences between two versions of the page.

--- en:docs:fapi:dosqfilemode [2020/12/04 12:56] – prokushev
+++ en:docs:fapi:dosqfilemode [2021/09/17 08:06] (current) – prokushev
@@ Line 1: / Line 1: @@
-{{logos:os2.gif?35x35}} {{logos:dos.gif?35x35}}
+{{page>en:templates:fapiint}}
 ====== DosQFileMode ======
@@ Line 5: / Line 5: @@
 This call queries the mode (attribute) of the specified file.
-==Syntax==
+===== Syntax =====
- DosQFileMode (FilePathName, CurrentAttribute, Reserved)
+<code c>
+DosQFileMode (FilePathName, CurrentAttribute, Reserved)
+</code>
+===== Parameters =====
+  * FilePathName ([[PSZ]]) - input : Address of the file path name.
+[[DosQSysInfo]] is called by an application during initialization to determine the maximum path length allowed by OS/2.
+  * CurrentAttribute ([[PUSHORT]]) - output : Address of the file's current attribute.
+^ Bit  ^ Description ^
+| 15-6 | Reserved |
+| 5    | File archive |
+| 4    | Subdirectory |
+| 3    | Reserved |
+| 2    | System file |
+| 1    | Hidden file |
+| 0    | Read only file |
-==Parameters==
-;FilePathName (PSZ) - input : Address of the file path name.
-:DosQSysInfo is called by an application during initialization to determine the maximum path length allowed by OS/2.
-;CurrentAttribute (PUSHORT) - output : Address of the file's current attribute.
- '''Bit   Description'''
--6  Reserved.
-     File archive
-     Subdirectory
-     Reserved
-     System file
-     Hidden file
-     Read only file
 These bits can be set individually or in combination. For example, an attribute value of 0021H (bits 5 and 0 set to 1) indicates a read-only file that is archived.
-; Reserved (ULONG) - input : Reserved must be set to zero.
-==Return Code==
+  * Reserved ([[ULONG]]) - input : Reserved must be set to zero.
- rc (USHORT) - return
+===== Return Code =====
+ rc ([[USHORT]]) - return
 Return code descriptions are:
-* 0   NO_ERROR
-* 2   ERROR_FILE_NOT_FOUND
-* 3   ERROR_PATH_NOT_FOUND
-* 26  ERROR_NOT_DOS_DISK
-* 87  ERROR_INVALID_PARAMETER
-* 108 ERROR_DRIVE_LOCKED
-* 206 ERROR_FILENAME_EXCED_RANGE
-==Remarks==
+  * 0   NO_ERROR
+  * 2   ERROR_FILE_NOT_FOUND
+  * 3   ERROR_PATH_NOT_FOUND
+  * 26  ERROR_NOT_DOS_DISK
+  * 87  ERROR_INVALID_PARAMETER
+  * 108 ERROR_DRIVE_LOCKED
+  * 206 ERROR_FILENAME_EXCED_RANGE
+===== Remarks =====
 The "Volume Label" type attribute is not returned by DosQFileMode. [[DosQFSInfo]] may be used for this purpose.
-==Example Code==
+===== Example Code =====
-===C Binding===
-<PRE>
+==== C Binding ====
+<code c>
 #define INCL_DOSFILEMGR
@@ Line 49: / Line 64: @@
 USHORT  rc;               /* return code */
-</PRE>
+</code>
-===MASM Binding===
+==== MASM Binding ====
-<PRE>
+<code asm>
 EXTRN  DosQFileMode:FAR
 INCL_DOSFILEMGR     EQU 1
@@ Line 61: / Line 77: @@
 CALL   DosQFileMode
-Returns WORD
+</code>
-</PRE>
+Returns WORD
+===== Note =====
-====== Note ======
 Text based on http://www.edm2.com/index.php/DosQFileMode