IDataStorage::RepresentAs: различия между версиями

Материал из CAMaaS preliminary wiki
Перейти к навигации Перейти к поиску
Строка 7: Строка 7:
{{function_end}}
{{function_end}}


В случае успешного завершения функции, полученный через параметр <tt>ppInterface</tt> объект необходимо закрывать вызовом его метода [[InterfaceBase::Release|Release]] отдельно и независимо от объекта, над которым применен метод [[IBinaryDataBase::RepresentAs|RepresentAs]].
В случае успешного завершения функции, полученный через параметр <tt>ppInterface</tt> объект необходимо закрывать вызовом его метода [[InterfaceBase::Release|Release]] отдельно и независимо от объекта, над которым применен метод [[IDataStorage::RepresentAs|RepresentAs]].


Для проверки доступности того или иного интерфейса предпочтительно использовать метод [[IDataStorage::IsInterfaceAvailable]].
Для проверки доступности того или иного интерфейса предпочтительно использовать метод [[IDataStorage::IsInterfaceAvailable]].

Версия 07:20, 21 апреля 2017

 return_code_t RepresentAs(DataStorageTypeId type_id, _Deref_out_ void** ppInterface) noexcept;

Осуществляет преобразование в интерфейс, заданный идентификатором.

Параметры
type_id32-х битовое целое, принимающее одно из следующих значений идентификаторов интерфейсов.
Символическое имяЦелочисленное значениеОписание
DataStorageType0Идентификатор интерфейса IDataStorage.
ConsequentDataStorageInputType2Идентификатор интерфейса IConsequentDataStorageInput.
ArbitrarilyAccessedDataStorageInputType3Идентификатор интерфейса IArbitrarilyAccessedDataStorageInput.
ContiguousDataStorageInputType4Идентификатор интерфейса IContiguousDataStorageInput.
InMemoryDataStorageInputType5Идентификатор интерфейса IInMemoryDataStorageInput.
AssociativeDataStorageInputType6Идентификатор интерфейса IAssociativeDataStorageInput.
ConsequentDataStorageOutputType0x101Идентификатор интерфейса IConsequentDataStorageOutput.
ArbitrarilyAccessedDataStorageOutputType0x102Идентификатор интерфейса IArbitrarilyAccessedDataStorageOutput.
ContiguousDataStorageOutputType0x103Идентификатор интерфейса IContiguousDataStorageOutput.
AssociativeDataStorageOutputType0x103Идентификатор интерфейса IAssociativeDataStorageOutput.
ConsequentDataStorageType0x201Идентификатор интерфейса IConsequentDataStorage.
ArbitrarilyAccessedDataStorageType0x202Идентификатор интерфейса IArbitrarilyAccessedDataStorage.
ContiguousDataStorageType0x203Идентификатор интерфейса IContiguousDataStorage.
InMemoryDataStorageType0x204Идентификатор интерфейса IInMemoryDataStorage.
AssociativeDataStorageType0x205Идентификатор интерфейса IAssociativeDataStorage.
[out]ppInterfaceВыходной указатель, принимающий интерфейс заданного типа или 0 в случае ошибки.
Возвращаемое значение:
32-битовый целый код ошибки, который в случае успешного выполнения неотрицателен (старший бит сброшен). В случае, если интерфейс, заданный идентификатором, не поддерживается, возвращается код CHSVERROR_INVALID_PARAMETER.

В случае успешного завершения функции, полученный через параметр ppInterface объект необходимо закрывать вызовом его метода Release отдельно и независимо от объекта, над которым применен метод RepresentAs.

Для проверки доступности того или иного интерфейса предпочтительно использовать метод IDataStorage::IsInterfaceAvailable.

Пример:

TODO: переделать под новые интерфейсы


	char l_filename[] = "./somefile";
	std::size_t cb_filename = sizeof(l_filename) - 1 /*term. 0*/;

	IContiguousDataStorage* pIO = nullptr;
	IDataStorage* pStorage = nullptr;
	return_code_t err = CreateFileAsBinaryDataStorage(l_filename, cb_filename, FileRead | FileWrite, FileCreateAlways, &pStorage);
	if (err < 0)
		goto cleanup; //failure of CreateFileAsBinaryDataStorage
	err = pStorage->IsInterfaceAvailable(ContiguousDataStorageType);
	if (err < 0)
		goto cleanup; //failure of IsInterfaceAvailable
	err = pStorage->RepresentAs(ContiguousDataStorageType, (void**) &pIO);
	if (err < 0)
		goto cleanup; //failure of RepresentAs
	
	//access the file via pIO...
	
cleanup:
	if (pStorage)
		pStrorage->Release();
	if (pIO)
		pIO->Release();