Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
en:docs:fapi:dosdelete [2018/09/02 03:01] – prokushev | en:docs:fapi:dosdelete [2021/12/05 09:53] (current) – prokushev | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | {{logos:os2.gif? | + | {{page>en:templates:fapiint}} |
====== DosDelete ====== | ====== DosDelete ====== | ||
This call removes a directory entry associated with a file name. | This call removes a directory entry associated with a file name. | ||
- | ==Syntax== | + | ===== Syntax |
- | | + | <code c> |
+ | DosDelete (FileName, Reserved) | ||
+ | </ | ||
- | ==Parameters== | + | ===== Parameters |
- | *FileName (PSZ) - input : Address of the name of the file to be deleted. | + | *FileName ([[PSZ]]) - input : Address of the name of the file to be deleted. |
- | DosQSysInfo is called by an application during initialization to determine the maximum path length allowed by OS/2. | + | * Reserved ([[ULONG]]) - input : Reserved and must be set to zero. |
- | * Reserved (ULONG) - input : Reserved and must be set to zero. | + | |
+ | ===== Return Code ===== | ||
- | ==Return Code== | ||
rc (USHORT) - return | rc (USHORT) - return | ||
Line 30: | Line 33: | ||
* 206 | * 206 | ||
- | ==Remarks== | + | ===== Remarks |
Global file name characters are not permitted. | Global file name characters are not permitted. | ||
- | A file whose read-only attribute is set cannot be deleted. To change the setting of the read-only bit, call DosSetFileMode. | + | A file whose read-only attribute is set cannot be deleted. To change the setting of the read-only bit, call [[DosSetFileMode]]. |
- | ==Example Code== | + | ===== Bindings |
- | ===C Binding=== | + | |
+ | ==== C Binding ==== | ||
+ | |||
+ | <code c> | ||
#define INCL_DOSFILEMGR | #define INCL_DOSFILEMGR | ||
| | ||
Line 47: | Line 52: | ||
| | ||
USHORT | USHORT | ||
+ | </ | ||
- | This example deletes a file in the current directory named test.dat. | + | ==== Example ==== |
+ | This example deletes a file in the current directory named test.dat. | ||
+ | <code c> | ||
#define INCL_DOSFILEMGR | #define INCL_DOSFILEMGR | ||
| | ||
Line 59: | Line 67: | ||
rc = DosDelete(FILE_DELETE, | rc = DosDelete(FILE_DELETE, | ||
RESERVED); | RESERVED); | ||
+ | </ | ||
- | ===MASM Binding=== | + | ==== MASM Binding |
+ | <code asm> | ||
EXTRN DosDelete: | EXTRN DosDelete: | ||
INCL_DOSFILEMGR | INCL_DOSFILEMGR | ||
Line 68: | Line 78: | ||
PUSH | PUSH | ||
CALL | CALL | ||
+ | </ | ||
Returns WORD | Returns WORD | ||
- | ====== Note ====== | + | ===== Note ===== |
Text based on [[http:// | Text based on [[http:// |