The mmioFindElement function is a high-level interface to enumerate elements from a compound file.

For MMIO_FE_FINDFIRST and MMIO_FE_FINDNEXT, the pszElement parameter contains the name of an element in the specified compound file upon return. Only one MMIO_FE_FINDFIRST and MMIO_FE_FINDNEXT sequence is supported for a file at any one time. If an element is not found, MMIOERR_CF_ENTRY_NOT_FOUND is returned and the pszElement parameter is set to an empty string.

For MMIO_FE_FINDELEMENT, the element name specified in pszElement is searched for. If the name is found, a zero return code is returned. If the element is not found, then MMIOERR_CF_ENTRY_NOT_FOUND is returned and the pszElement field is set to an empty string.

MMIO_FE_FINDEND should be called after the search is complete. This flag indicates the compound file should be closed. MMIO_FE_FINDFIRST opens the compound file on the first invocation, and the file remains open until MMIO_FE_FINDEND is called. The MMIO_FE_FINDEND flag must be sent after completing the search in order to close the file.


[Back] [Next]