MmioDescend

MMRESULT mmioDescend( HMMIO hmmio, LPMMCKINFO lpck, LPMMCKINFO lpckParent, UINT wFlags );

Возвращаемое значение

В случае успешного завершения возвращает значение MMSYSERR_NOERROR. В противном случае возвращаемое значение может принимать значение:

• MMIOERR_CHUNKNOTFOUND — достигнут конец файла (или конец родительского блока, если он задан), но искомый вложенный блок не обнаружен.

Аргументы

0. hmmio — дескриптор открытого файла формата RIFF.

1. lpck — указатель на определённый в приложении объект структуры MMCKINFO.

2. lpckParent — не обязательный указатель на определённый в приложении объект структуры MMCKINFO, идентифицирующий родительский блок искомого вложенного блока. Если этот аргумент имеет ненулевое значение, функция mmioDescend предполагает, что переданный в данном аргументе объект структуры MMCKINFO был заполнен при предыдущем вызове функции mmioDescend, производившей поиск родительского блока. В этом случае функция mmioDescend производит поиск только в пределах родительского блока. Если этот аргумент имеет нулевое значение, то не задаётся никакого родительского блока.

3. wFlags — флаги поиска. Если не установлен ни один из флагов, функция mmioDescend считает, что начало блока совпадает с текущей позицией в файле. Определены следующие значения:

• MMIO_FINDCHUNK — производится поиск вложенного блока по его идентификатору.

• MMIO_FINDLIST — производится поиск вложенного блока LIST с указанным идентификатором типа списка.

• MMIO_FINDRIFF — производится поиск вложенного блока RIFF с указанным идентификатором типа списка.

Примечание

Функция mmioDescend производит поиск и открывает вложенный блок в мультимедийном файле формата RIFF, открытого функцией mmioOpen.

Блок RIFF состоит из четырёхбуквенного кода идентификатора вложенного блока (типа FOURCC), четырёхбайтной переменной, содержащей размер области данных вложенного блока (типа DWORD) и области данных блока. Если область данных блока имеет нечётный размер, то после неё располагается нулевой байт, выравнивающий её по границе слова. У вложенных блоков, имеющих идентификаторы RIFF или LIST, первые четыре байта области данных занимает идентификатор типа данных (типа FOURCC).

При использовании функции mmioDescend для поиска вложенного блока следует убедиться, что при её вызове текущая позиция файла совпадает с началом некоторого вложенного блока. Поиск начинается с текущей позиции файла и продолжается до конца файла. Если определён родительский блок, при вызове функции mmioDescend текущая позиция файла должна располагаться в пределах этого блока. В этом случае поиск начинается с текущей позиции файла и продолжается до конца родительского блока.

Если в процессе выполнения функции mmioDescend возникла ошибка, текущая позиция в файле становится неопределённой. В случае успешного завершения работы данная функция изменяет текущую позицию файла. Если обнаружен блок RIFF или LIST, то текущая позиция файла располагается непосредственно после идентификатора типа данных или идентификатора типа списка (12 байт от начала вложенного блока). Для других вложенных блоков текущая позиция файла перемещается в начало области данных (8 байт от начала вложенного блока).

Функция mmioDescend заполняет переданный ей в аргументе lpck объект структуры MMCKINFO и заносит в него следующую информацию:

• В переменную ckid заносится идентификатор вложенного блока.

• В переменную cksize заносится размер области данных вложенного блока в байтах. Этот размер включает в себя идентификатор типа данных (если таковой имеется), но не включает 8-байтный заголовок вложенного блока и добавляемый для выравнивания по длине слова нулевой байт.

• Если переменная ckid имеет значение RIFF, то в переменной fccType содержится идентификатор типа данных этого блока, если же переменная ckid имеет значение LIST, то в переменной fccType содержится идентификатор типа списка. В противном случае данная переменная содержит нулевое значение.

• В переменной dwDataOffset содержится смещение области данных вложенного блока от начала файла. Для блоков RIFF или LIST данная переменная содержит смещение идентификатора типа данных или идентификатора типа списка.

• В переменной dwFlags должна содержаться дополнительная информация о вложенном блоке. В данной функции эта информация не используется и переменная dwFlags должна иметь нулевое значение.

Если в аргументе wFlags установлен флаг MMIO_FINDCHUNK, MMIO_FINDRIFF или MMIO_FINDLIST, то объект структуры MMCKINFO используется, также, и для передачи функции mmioDescend информации об искомом вложенном блоке.

Описание данной функции содержится в файле заголовка mmsystem.h. При работе с данной функцией следует включить в проект библиотеку winmm.lib.