IInMemoryDataStorageInput::GetPtr: различия между версиями
Перейти к навигации
Перейти к поиску
| Строка 1: | Строка 1: | ||
{{function_begin|return_code_t PLATFORM_NATIVE_CALLING_CONVENTION GetPtr( | {{function_begin|return_code_t PLATFORM_NATIVE_CALLING_CONVENTION GetPtr(const void** ppBuffer, std::size_t* pcbBuffer) const noexcept; |{{IInMemoryDataStorageInput::GetPtr brief}}}} | ||
{{function_paramlist begin}} | {{function_paramlist begin}} | ||
{{function_paramlist add|ppBuffer|.|paramdir=[out]}} | {{function_paramlist add|ppBuffer|В результате успешного выполнения функции получает адрес буфера памяти, управляемого накопителем.|paramdir=[out]}} | ||
{{function_paramlist add|pcbBuffer|.|paramdir=[out]}} | {{function_paramlist add|pcbBuffer|Опциональный указатель, который принимает байтовый размер буфера {{param|*ppBuffer}}. Клиенту разрешено адресовать и осуществлять чтение из буфера <tt>[(uint8_t) *ppBuffer, (uint8_t) *ppBuffer + *pcbBuffer)</tt> при условии соблюдения им ограничений, налагаемых реализацией на совместный ввод-вывод, если он осуществляется клиентом. В отличие от одноименного метода [[IInMemoryDataStorage::GetPtr|GetPtr]] интерфейса [[IInMemoryDataStorage]], выходное значение параметра {{param|pcbBuffer}} является длиной фактически имеющихся данных в буфере, в байтах, и равна значению, получаемому в результате вызова метода [[IContiguousDataStorageInput::GetByteSize|GetByteSize]], наследуемого у интерфейса [[IContiguousDataStorageInput]].|paramdir=[out]}} | ||
{{function_paramlist end}} | {{function_paramlist end}} | ||
{{function_return_value|32-битовый беззнаковый целый код ошибки, который в случае успешного выполнения неотрицателен.}} | {{function_return_value|32-битовый беззнаковый целый код ошибки, который в случае успешного выполнения неотрицателен.}} | ||
{{function_end}} | {{function_end}} | ||
Текущая версия на 00:13, 17 августа 2019
return_code_t PLATFORM_NATIVE_CALLING_CONVENTION GetPtr(const void** ppBuffer, std::size_t* pcbBuffer) const noexcept;
Возвращает адрес управляемого накопителем буфера данных в памяти.
- Параметры
[out] ppBuffer В результате успешного выполнения функции получает адрес буфера памяти, управляемого накопителем. [out] pcbBuffer Опциональный указатель, который принимает байтовый размер буфера *ppBuffer. Клиенту разрешено адресовать и осуществлять чтение из буфера [(uint8_t) *ppBuffer, (uint8_t) *ppBuffer + *pcbBuffer) при условии соблюдения им ограничений, налагаемых реализацией на совместный ввод-вывод, если он осуществляется клиентом. В отличие от одноименного метода GetPtr интерфейса IInMemoryDataStorage, выходное значение параметра pcbBuffer является длиной фактически имеющихся данных в буфере, в байтах, и равна значению, получаемому в результате вызова метода GetByteSize, наследуемого у интерфейса IContiguousDataStorageInput. - Возвращаемое значение:
- 32-битовый беззнаковый целый код ошибки, который в случае успешного выполнения неотрицателен.