| INT LZOpenFile(lpFileName, lpReOpenBuf, wStyle) | |||||
| LPSTR lpFileName; | /* specifies name of file to be opened | */ | |||
| LPOFSTRUCT lpReOpenBuf; | /* points to LPOFSTRUCT data structure | */ | |||
| WORD wStyle; | /* specifies the action to be taken | */ | |||
The LZOpenFile function creates, opens, reopens, or deletes the file identifies by the string at which lpFileName points.
lpFileName
Points to a string that specifies the name of a file.
lpReOpenBuf
Points to the OFSTRUCT structure that is to receive information about the file when the file is first opened. The structure can be used in subsequent calls to the LZOpenFile function to refer to the open file.
The szPathName field of this data structure contains characters from the OEM character set.
wStyle
Specifies the action to take. These styles can be combined by using the bitwise OR operator:
| Value | Meaning |
| OF_CANCEL | ||
| Adds a Cancel button to the OF_PROMPT dialog box. Pressing the Cancel button directs LZOpenFile to return a file-not-found error message. | ||
| OF_CREATE | ||
| Directs LZOpenFile to create a new file. If the file already exists, it is truncated to zero length. | ||
| OF_DELETE | ||
| Deletes the file. | ||
| OF_EXIST | ||
| Opens the file, and then closes it. Used to test for file existence. | ||
| OF_PARSE | ||
| Fills the OFSTRUCT data structure but carries out no other action. | ||
| OF_PROMPT | ||
| Displays a dialog box if the requested file does not exist. The dialog box informs the user that Windows cannot find the file and prompts the user to insert the file in drive A. | ||
| OF_READ | ||
| Opens the file for reading only. | ||
| OF_READWRITE | ||
| Opens the file for reading and writing. | ||
| OF_REOPEN | ||
| Opens the file using information in the re-open buffer. | ||
| OF_SHARE_DENY_NONE | ||
| Opens the file without denying other processes read or write access to the file. OpenFile fails if the file has been opened in compatibility mode by any other process. | ||
| OF_SHARE_DENY_READ | ||
| Opens the file and denies other processes read access to the file. LZOpenFile fails if the file has been opened in compatibility mode or for read access by any other process. | ||
| OF_SHARE_DENY_WRITE | ||
| Opens the file and denies other processes write access to the file. LZOpenFile fails if the file has been opened in compatibility or for write access by any other process. | ||
| OF_SHARE_EXCLUSIVE | ||
| Opens the file with exclusive mode, denying other processes both read and write access to the file. OpenFile fails if the file has been opened in any other mode for read or write access, even by the current process. | ||
| OF_WRITE | ||
| Opens the file for writing only. | ||
The return value is a handle identifying the file if the function is successful and the value specified by wStyle is not OF_READ. If the file is compressed and opened with wStyle set to OF_READ, the return value is a special file handle. If the function fails, the return value is -1. Extended error information is available by calling GetLastError.
If wStyle is OF_READ (or OF_READ and any of the OF_SHARE_ flags) and the file is compressed, LZOpenFile calls LZInit which performs the required initialization for the decompression operations.