AVIFileOpenA function (vfw.h)
The AVIFileOpen function opens an AVI file and returns the address of a file interface used to access it. The AVIFile library maintains a count of the number of times a file is opened, but not the number of times it was released. Use the AVIFileRelease function to release the file and decrement the count.
Syntax
HRESULT AVIFileOpenA(
PAVIFILE *ppfile,
LPCSTR szFile,
UINT uMode,
LPCLSID lpHandler
);
Parameters
ppfile
Pointer to a buffer that receives the new IAVIFile interface pointer.
szFile
Null-terminated string containing the name of the file to open.
uMode
Access mode to use when opening the file. The default access mode is OF_READ. The following access modes can be specified with AVIFileOpen.
| Value | Meaning |
|---|---|
| OF_CREATE | Creates a new file. If the file already exists, it is truncated to zero length. |
| OF_PARSE | Skips time-consuming operations, such as building an index. Set this flag if you want the function to return as quickly as possible—for example, if you are going to query the file properties but not read the file. |
| OF_READ | Opens the file for reading. |
| OF_READWRITE | Opens the file for reading and writing. |
| OF_SHARE_DENY_NONE | Opens the file nonexclusively. Other processes can open the file with read or write access. AVIFileOpen fails if another process has opened the file in compatibility mode. |
| OF_SHARE_DENY_READ | Opens the file nonexclusively. Other processes can open the file with write access. AVIFileOpen fails if another process has opened the file in compatibility mode or has read access to it. |
| OF_SHARE_DENY_WRITE | Opens the file nonexclusively. Other processes can open the file with read access. AVIFileOpen fails if another process has opened the file in compatibility mode or has write access to it. |
| OF_SHARE_EXCLUSIVE | Opens the file and denies other processes any access to it. AVIFileOpen fails if any other process has opened the file. |
| OF_WRITE | Opens the file for writing. |
lpHandler
Pointer to a class identifier of the standard or custom handler you want to use. If the value is NULL, the system chooses a handler from the registry based on the file extension or the RIFF type specified in the file.
Return value
Returns zero if successful or an error otherwise. Possible error values include the following.
| Return code | Description |
|---|---|
|
The file couldn't be read, indicating a corrupt file or an unrecognized format. |
|
The file could not be opened because of insufficient memory. |
|
A disk error occurred while reading the file. |
|
A disk error occurred while opening the file. |
|
According to the registry, the type of file specified in AVIFileOpen does not have a handler to process it. |
Remarks
Note
The vfw.h header defines AVIFileOpen as an alias that automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that is not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows 2000 Professional [desktop apps only] |
| Minimum supported server | Windows 2000 Server [desktop apps only] |
| Target Platform | Windows |
| Header | vfw.h |
| Library | Vfw32.lib |
| DLL | Avifil32.dll |