en:docs:fapi:dosdelete

This is part of Family API which allow to create dual-os version of program runs under OS/2 and DOS

Note: This is legacy API call. It is recommended to use 32-bit equivalent

2021/09/17 06:47 · prokushev
2021/08/20 05:18 · prokushev

DosDelete

This call removes a directory entry associated with a file name.

Syntax

DosDelete (FileName, Reserved)

Parameters

  • 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.

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
  • 206 ERROR_FILENAME_EXCED_RANGE

Remarks

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.

Bindings

C Binding

  #define INCL_DOSFILEMGR
 
  USHORT  rc = DosDelete(FileName, Reserved);
 
  PSZ              FileName;      /* File name path */
  ULONG            0;             /* Reserved (must be zero) */
 
  USHORT           rc;            /* return code */

Example

This example deletes a file in the current directory named test.dat.

  #define INCL_DOSFILEMGR
 
  #define FILE_DELETE "test.dat"
  #define RESERVED 0L
 
  USHORT rc;
 
   rc = DosDelete(FILE_DELETE,    /* File path name */
                  RESERVED);      /* Reserved (must be zero) */

MASM Binding

  EXTRN  DosDelete:FAR
  INCL_DOSFILEMGR     EQU 1
 
  PUSH@  ASCIIZ  FileName      ;Filename path name string
  PUSH   DWORD   0             ;Reserved (must be zero)
  CALL   DosDelete

Returns WORD

Note


en/docs/fapi/dosdelete.txt · Last modified: 2021/09/17 06:49 by prokushev