mmioCFFindEntry - Parameters

hmmcf (HMMCF) - input

A RIFF compound-file handle returned by mmioCFOpen.

pmmctocentry (PMMCTOCENTRY) - in/out

A pointer to the MMCTOCENTRY structure containing the name of the RIFF compound-file element to search for. This structure is variable in size and the user must ensure enough memory has been allocated for it. Flags in ulFlags can be set to specify that an element is to be searched for by some attribute other than name.

ulFlags (ULONG) - input

This parameter can be used to specify that an element is to be searched for by some attribute other than name. The MMIO_FINDFIRST and MMIO_FINDNEXT flags are mutually exclusive. An MMIOERR_CF_ENTRY_NOT_USED error is returned if a matching entry is not found or if MMIO_FINDNEXT was specified and no more entries match the search CTOC entry.

The following flags are supported:

MMIO_FINDFIRST

Find the first entry in the CTOC table.
MMIO_FINDNEXT
Find the next entry in the CTOC table after the entry previously found and returned in the pmmctocentry parameter. The pmmctocentry parameter must contain the previous CTOC entry. Returns NULL if pmmctocentry refers to the last entry.
MMIO_FINDDELETED
Find an entry in the CTOC table that has been marked as deleted
MMIO_FINDUNUSED
Find an entry in the CTOC table that has been marked as unused. A default compound file contains 16 unused CTOC entries in the CTOC table. As each CTOC entry and element is added, one of these unused entries is used.

rc (ULONG) - returns

Return codes indicating success or type of failure:

MMIO_CF_SUCCESS

If the function succeeds, 0 is returned.
MMIOERR_INVALID_HANDLE
The handle passed was not valid.
MMIOERR_INVALID_PARAMETER
For this function a pszElementName, pchBuffer, or cchBytes NULL is invalid.
MMIOERR_READ_ONLY_FILE
The RIFF compound-file is opened as read-only.
MMIOERR_CF_ENTRY_NOT_FOUND
System failed to find CTOC entry.
MMIO_CF_FAILURE
The function failed. A call to mmioGetLastError might return one of the following errors:

MMIOERR_WRITE_ONLY_FILE

File not opened in read mode.
MMIOERR_INTERNAL_SYSTEM
The operation failed due to an internal system error.

---

[Back: mmioCFFindEntry Return Value - rc]
[Next: mmioCFFindEntry - Remarks]