Jump to content

DosSetFileMode: Difference between revisions

From EDM2
← Older edit
Ak120 (talk | contribs)
35,819 edits
mNo edit summary
Ak120 (talk | contribs)
35,819 edits
 
(2 intermediate revisions by 2 users not shown)
Line 8: Line 8:
:[[DosQSysInfo]] is called by an application during initialization to determine the maximum path length allowed by OS/2.
:[[DosQSysInfo]] is called by an application during initialization to determine the maximum path length allowed by OS/2.
;NewAttribute (USHORT) - input : File's new attribute. File attributes are defined as follows:
;NewAttribute (USHORT) - input : File's new attribute. File attributes are defined as follows:
'''Bit        Description'''
::15-6 - Reserved and must be zero.
15-6       Reserved and must be zero.
::5 - File archive
5       File archive
::4 - Subdirectory
4       Subdirectory
::3 - Volume label
3       Volume label
::2 - System file (excluded from normal directory searches)
2       System file (excluded from normal directory searches)
::1 - Hidden file
1       Hidden file
::0 - Read only file
0       Read only file
:These bits may 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 should be archived.
:These bits may 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 should be archived.
;Reserved (ULONG) - input : Reserved must be set to zero.
;Reserved (ULONG) - input : Reserved must be set to zero.


==Return Code==
==Return Code==
rc (USHORT) - return
;rc (USHORT) - return:Return code descriptions are:
Return code descriptions are:
* 0 NO_ERROR
* 0       NO_ERROR  
* 2 ERROR_FILE_NOT_FOUND
* 2       ERROR_FILE_NOT_FOUND  
* 3 ERROR_PATH_NOT_FOUND
* 3       ERROR_PATH_NOT_FOUND  
* 5 ERROR_ACCESS_DENIED
* 5       ERROR_ACCESS_DENIED  
* 26 ERROR_NOT_DOS_DISK
* 26       ERROR_NOT_DOS_DISK  
* 32 ERROR_SHARING_VIOLATION
* 32       ERROR_SHARING_VIOLATION  
* 36 ERROR_SHARING_BUFFER_EXCEEDED
* 36       ERROR_SHARING_BUFFER_EXCEEDED  
* 87 ERROR_INVALID_PARAMETER
* 87       ERROR_INVALID_PARAMETER
*108 ERROR_DRIVE_LOCKED
* 108       ERROR_DRIVE_LOCKED  
*206 ERROR_FILENAME_EXCED_RANGE
* 206       ERROR_FILENAME_EXCED_RANGE


==Remarks==
==Remarks==
Line 40: Line 38:
Attributes of root directories cannot be changed using DosSetFileMode. If these attributes are specified, ERROR_ACCESS_DENIED is returned.  
Attributes of root directories cannot be changed using DosSetFileMode. If these attributes are specified, ERROR_ACCESS_DENIED is returned.  


==Example Code==
==Bindings==
=== C Binding===
===C===
<PRE>
<PRE>
#define INCL_DOSFILEMGR
#define INCL_DOSFILEMGR
Line 47: Line 45:
USHORT  rc = DosSetFileMode(FileName, NewAttribute, Reserved);
USHORT  rc = DosSetFileMode(FileName, NewAttribute, Reserved);


PSZ             FileName;      /* File path name string */
PSZ     FileName;      /* File path name string */
USHORT           NewAttribute;  /* New attribute of file */
USHORT NewAttribute;  /* New attribute of file */
ULONG           0;            /* Reserved (must be zero) */
ULONG   0;            /* Reserved (must be zero) */


USHORT           rc;            /* return code */
USHORT rc;            /* return code */
</PRE>
</PRE>


===MASM Binding===
===MASM===
<PRE>
<PRE>
EXTRN  DosSetFileMode:FAR
EXTRN  DosSetFileMode:FAR
Line 66: Line 64:
Returns WORD
Returns WORD
</PRE>
</PRE>
==Related Functions==
* [[DosQFileMode]]


[[Category:Dos]]
[[Category:Dos]]

Latest revision as of 02:12, 20 February 2023

This call changes the mode (attribute) of the specified file.

Syntax

DosSetFileMode (FileName, NewAttribute, Reserved)

Parameters

FileName (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.
NewAttribute (USHORT) - input
File's new attribute. File attributes are defined as follows:
15-6 - Reserved and must be zero.
5 - File archive
4 - Subdirectory
3 - Volume label
2 - System file (excluded from normal directory searches)
1 - Hidden file
0 - Read only file
These bits may 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 should be archived.
Reserved (ULONG) - input
Reserved must be set to zero.

Return Code

rc (USHORT) - return
Return code descriptions are:
  • 0 NO_ERROR
  • 2 ERROR_FILE_NOT_FOUND
  • 3 ERROR_PATH_NOT_FOUND
  • 5 ERROR_ACCESS_DENIED
  • 26 ERROR_NOT_DOS_DISK
  • 32 ERROR_SHARING_VIOLATION
  • 36 ERROR_SHARING_BUFFER_EXCEEDED
  • 87 ERROR_INVALID_PARAMETER
  • 108 ERROR_DRIVE_LOCKED
  • 206 ERROR_FILENAME_EXCED_RANGE

Remarks

Attributes for Volume Label (0008H) and Subdirectory (0010H) cannot be changed using DosSetFileMode. If these attributes are specified, ERROR_INVALID_PARAMETER is returned.

DosQFileMode is used to query the current settings for file attributes. Calling DosQFSInfo obtains volume label information.

Attributes of root directories cannot be changed using DosSetFileMode. If these attributes are specified, ERROR_ACCESS_DENIED is returned.

Bindings

C

#define INCL_DOSFILEMGR

USHORT  rc = DosSetFileMode(FileName, NewAttribute, Reserved);

PSZ     FileName;      /* File path name string */
USHORT  NewAttribute;  /* New attribute of file */
ULONG   0;             /* Reserved (must be zero) */

USHORT  rc;            /* return code */

MASM

EXTRN  DosSetFileMode:FAR
INCL_DOSFILEMGR     EQU 1

PUSH@  ASCIIZ  FileName      ;File path name string
PUSH   WORD    NewAttribute  ;New attribute of file
PUSH   DWORD   0             ;Reserved (must be zero)
CALL   DosSetFileMode

Returns WORD
Retrieved from "https://www.edm2.com/index.php?title=DosSetFileMode&oldid=80235"