IInputStream::Read: различия между версиями
Перейти к навигации
Перейти к поиску
| Строка 3: | Строка 3: | ||
{{function_paramlist add|pElement|Выходной указатель на один элемент, приведенный к общему виду. Предполагается осведомленность клиента о типе элемента - это либо скалярный тип, либо [[Программный интерфейс|интерфейс]]. Если элементом является скалярный тип, метод принимает указатель на неинициализированное значение. Если элементом является интерфейс, то в качестве параметра задается указатель, значению которого методом присваивается адрес реализации интерфейса, которую нужно закрывать с помощью ее метода [[InterfaceBase::Release|Release]].|paramdir=[out]}} | {{function_paramlist add|pElement|Выходной указатель на один элемент, приведенный к общему виду. Предполагается осведомленность клиента о типе элемента - это либо скалярный тип, либо [[Программный интерфейс|интерфейс]]. Если элементом является скалярный тип, метод принимает указатель на неинициализированное значение. Если элементом является интерфейс, то в качестве параметра задается указатель, значению которого методом присваивается адрес реализации интерфейса, которую нужно закрывать с помощью ее метода [[InterfaceBase::Release|Release]].|paramdir=[out]}} | ||
{{function_paramlist end}} | {{function_paramlist end}} | ||
{{function_return_value|32-битовый беззнаковый целый код ошибки, который в случае успешного выполнения неотрицателен.}} | {{function_return_value|32-битовый беззнаковый целый код ошибки, который в случае успешного выполнения неотрицателен. Если элемент успешно считан возвращается [https://www.chusov.org/doxygen/group___error_handling.html#CHSVCODES CHSVERROR_SUCCESS] (0x20000000). Если элемент считать не удалось по причине отсутствия в потоке элементов, возвращается [https://www.chusov.org/doxygen/group___error_handling.html#CHSVCODES CHSVERROR_SUCCESS_FALSE] (0x20000001). В этом случае результат последующих попыток считывания из потока на уровне абстракции [[IInputStream]] не определен.}} | ||
{{function_end}} | {{function_end}} | ||
Версия 18:19, 1 мая 2017
return_code_t Read( void* pElement) const noexcept;
Считывает из потока один элемент.
- Параметры
[out] pElement Выходной указатель на один элемент, приведенный к общему виду. Предполагается осведомленность клиента о типе элемента - это либо скалярный тип, либо интерфейс. Если элементом является скалярный тип, метод принимает указатель на неинициализированное значение. Если элементом является интерфейс, то в качестве параметра задается указатель, значению которого методом присваивается адрес реализации интерфейса, которую нужно закрывать с помощью ее метода Release. - Возвращаемое значение:
- 32-битовый беззнаковый целый код ошибки, который в случае успешного выполнения неотрицателен. Если элемент успешно считан возвращается CHSVERROR_SUCCESS (0x20000000). Если элемент считать не удалось по причине отсутствия в потоке элементов, возвращается CHSVERROR_SUCCESS_FALSE (0x20000001). В этом случае результат последующих попыток считывания из потока на уровне абстракции IInputStream не определен.