DosChDir

From EDM2
Jump to: navigation, search
Att.gif Legacy Function Warning
It is recommended to use a newer replacement for this function.
Replacement: DosSetCurrentDir
Remarks: Renamed to "DosSetCurrentDir" in OS/2 2.0.

This call defines the current directory for the requesting process.

Syntax

DosChDir (DirName, Reserved)

Parameters

DirName (PSZ) - input 
Address of the ASCIIZ directory path name.
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
  • 8 ERROR_NOT_ENOUGH_MEMORY
  • 26 ERROR_NOT_DOS_DISK
  • 87 ERROR_INVALID_PARAMETER
  • 108 ERROR_DRIVE_LOCKED
  • 206 ERROR_FILENAME_EXCED_RANGE

Remarks

The directory path is not changed if any member of the path does not exist. The current directory changes only for the requesting process.

For FSDs, the case of the current directory is set according to the DirName passed in, not according to the case of the directories on disk. For example, if the directory "c:\bin" is created and DosChDir is called with DirName "c:\bin", the current directory returned by DosQCurDir will be "c:\bin".

Programs running without the NEWFILES bit set are allowed to DosChDir to a non-8.3 filename format directory.

DosQSysInfo must be used by an application to determine the maximum path length supported by OS/2. The returned value should be used to dynamically allocate buffers that are to be used to store paths.

Bindings

C

#define INCL_DOSFILEMGR

USHORT  rc = DosChDir(DirName, Reserved);

PSZ     DirName;       /* Directory path name *
ULONG   0;             /* Reserved (must be zero) */

USHORT  rc;            /* return code */

MASM

EXTRN  DosChDir:FAR
INCL_DOSFILEMGR     EQU 1

PUSH@  ASCIIZ  DirName       ;Directory path name string
PUSH   DWORD   0             ;Reserved (must be zero)
CALL   DosChDir

Returns WORD

Example Code

This example changes directories to \os2\system.

#define INCL_DOSFILEMGR

#define PATH "\\os2\\system"
#define RESERVED 0L

USHORT rc;

   rc = DosChDir(PATH, RESERVED);