DosProtectOpenL

DosProtectOpenL opens a new file, an existing file, or a replacement for an existing file and returns a protected file handle. An open file can have extended attributes.

Syntax
DosProtectOpenL (pszFileName, phf, pulAction,                 cbFile, ulAttribute, fsOpenFlags, fsOpenMode,                  peaop2, pfhFileHandleLockID)

Parameters

 * pszFileName (PSZ) input: Address of the ASCIIZ path name of the file or device to be opened.
 * phf (PHFILE) output: Address of the handle for the file.
 * pulAction (PULONG) output: A pointer to the ULONG in which the value that specifies the action taken by DosProtectOpenL is returned.
 * If DosProtectOpenL fails, this value has no meaning. Otherwise, it is one of the following values:
 * FILE_EXISTED  File already existed.
 * FILE_CREATED  File was created.
 * FILE_TRUNCATED File existed and was changed to a given size (file was replaced).


 * cbFile (LONGLONG) input: New logical size of the file (end of data, EOD), in bytes.
 * This parameter is significant only when creating a new file or replacing an existing one. Otherwise, it is ignored. It is an error to create or replace a file with a non-zero length if the fsOpenMode Access-Mode flag is set to read-only.


 * ulAttribute (ULONG) (input: File attributes.
 * This parameter contains the following bit fields

31-6 Reserved, must be 0. 5   FILE_ARCHIVED (0x00000020) File has been archived. 4   FILE_DIRECTORY(0x00000010) File is a subdirectory. 3   Reserved, must be 0. 2   FILE_SYSTEM   (0x00000004) File is a system file. 1   FILE_HIDDEN   (0x00000002) File is hidden and does not appear in a directory listing. 0   FILE_READONLY (0x00000001) File can be read from, but not written to. 0   FILE_NORMAL   (0x00000000) File can be read from or written to.
 * File attributes apply only if the file is created.
 * These bits may be set individually or in combination. For example, an attribute value of 0x00000021 (bits 5 and 0 set to 1) indicates a read-only file that has been archived.


 * fsOpenFlags (ULONG) input: The action to be taken depending on whether the file exists or does not exist.
 * This parameter contains the following bit fields

31-8 Reserved, must be 0. 7-4 The following flags apply if the file does not exist 0000 OPEN_ACTION_FAIL_IF_NEW       Open an existing file; fail if the file does not exist. 0001 OPEN_ACTION_CREATE_IF_NEW     Create the file if the file does not exist. 3 0 The following flags apply if the file does not exist 0000 OPEN_ACTION_FAIL_IF_EXISTS    Open the file; fail if the file already exists. 0001 OPEN_ACTION_OPEN_IF_EXISTS    Open the file if it already exists. 0010 OPEN_ACTION_REPLACE_IF_EXISTS Replace the file if it already exists. File sharing requires the cooperation of sharing processes. This cooperation is communicated through sharing and access modes. Any sharing restrictions placed on a file opened by a process are removed when the process closes the file with a DosClose request.
 * fsOpenMode (ULONG) input: The mode of the open function. This parameter contains the following bit fields:
 * Sharing Mode: Specifies the type of file access that other processes may have. For example, if other processes can continue to read the file while your process is operating on it, specify Deny Write. The sharing mode prevents other processes from writing to the file but still allows them to read it.

If the file is inherited by a child process, all sharing and access restrictions also are inherited.
 * Access Mode: Specifies the type of file access (access mode) needed by your process. For example, if your process requires read/write access, and another process has already opened the file with a sharing mode of Deny None, your DosProtectOpenL request succeeds. However, if the file is open with a sharing mode of Deny Write, the process is denied access.

If an open file handle is duplicated by a call to DosDupHandle, all sharing and access restrictions also are duplicated.


 * peaop2 (PEAOP2) in/out:A pointer to an extended attribute buffer.
 * Input: The address of the extended-attribute buffer, which contains an EAOP2 structure. The fpFEA2List field in the EAOP2 structure points to a data area where the relevant FEA2 list is to be found. The fpGEA2List and oError fields are ignored.
 * Output: fpGEA2List and fpFEA2List are unchanged. The area that fpFEA2List points to is unchanged. If an error occurred during the set, oError is the offset of the FEA2 entry where the error occurred. The return code from DosProtectOpenL is the error code for that error condition. If no error occurred, oError is undefined.
 * If peaop2 is zero, then no extended attributes are defined for the file. If extended attributes are not to be defined or modified, the pointer peaop2 must be set to zero.


 * pfhFileHandleLockID (PFHLOCK) output: The address of the 32-bit lockid for the file handle.

Return Code
ulrc APIRET) returns DosProtectOpenL returns one of the following values
 * NO_ERROR
 * ERROR_FILE_NOT_FOUND
 * ERROR_PATH_NOT_FOUND
 * ERROR_TOO_MANY_OPEN_FILES
 * ERROR_ACCESS_DENIED
 * 12  ERROR_INVALID_ACCESS
 * 26  ERROR_NOT_DOS_DISK
 * 32  ERROR_SHARING_VIOLATION
 * 36  ERROR_SHARING_BUFFER_EXCEEDED
 * 82  ERROR_CANNOT_MAKE
 * 87  ERROR_INVALID_PARAMETER
 * 99  ERROR_DEVICE_IN_USE
 * 108 ERROR_DRIVE_LOCKED
 * 110 ERROR_OPEN_FAILED
 * 112 ERROR_DISK_FULL
 * 206 ERROR_FILENAME_EXCED_RANGE
 * 231 ERROR_PIPE_BUSY

Remarks
A successful DosProtectOpenL request returns a handle and a 32-bit lockid for accessing the file. The read/write pointer is set at the first byte of the file. The position of the pointer can be changed with DosProtectSetFilePtrL or by read and write operations on the file.

The file s date and time can be queried with DosProtectQueryFileInfo. They are set with DosProtectSetFileInfo.

The read-only attribute of a file can be set with the ATTRIB command.

ulAttribute cannot be set to Volume Label. To set volume-label information, issue DosProtectSetFileInfo with a logical drive number. Volume labels cannot be opened.

cbFile affects the size of the file only when the file is new or is a replacement. If an existing file is opened, cbFile is ignored. To change the size of the existing file, issue DosProtectSetFileSizeL.

The value in cbFile is a recommended size. If the full size cannot be allocated, the open request may still succeed. The file system makes a reasonable attempt to allocate the new size in an area that is as nearly contiguous as possible on the medium. When the file size is extended, the values of the new bytes are undefined.

The Direct Open bit provides direct access to an entire disk or diskette volume, independent of the file system. This mode of opening the volume that is currently on the drive returns a handle to the calling function; the handle represents the logical volume as a single file. The calling function specifies this handle with a DosDevIOCtl Category 8, DSK_LOCKDRIVE request to prevent other processes from accessing the logical volume. When you are finished using the logical volume, issue a DosDevIOCtl Category 8, DSK_UNLOCKDRIVE request to allow other processes to access the logical volume.

The file-handle state bits can be set by DosProtectOpenL and DosProtectSetFHState. An application can query the file-handle state bits, as well as the rest of the Open Mode field, by issuing DosProtectQueryFHState.

You can use an EAOP2 structure to set extended attributes in peaop2 when creating a file, replacing an existing file, or truncating an existing file. No extended attributes are set when an existing file is just opened.

A replacement operation is logically equivalent to atomically deleting and re-creating the file. This means that any extended attributes associated with the file also are deleted before the file is re-created.

The pfhFileHandleLockID returned is required on each of the DosProtectxxx functions. An incorrect pfhFileHandleLockID on subsequent DosProtectxxx calls results in an ERROR_ACCESS_DENIED return code.

The DosProtectxxx functions can be used with a NULL filehandle lockid, if the subject filehandle was obtained from DosOpen.

Example Code
This example opens or creates and opens a file named DOSPROT.DAT, writes to it, reads from it, and finally closes it using DosProtect functions.

Related Functions

 * DosDevIOCtl
 * DosDupHandle
 * DosProtectClose
 * DosProtectSetFileInfo
 * DosProtectSetFilePtrL
 * DosProtectSetFileSizeL
 * DosQueryHType
 * DosSetMaxFH
 * DosSetRelMaxFH