Найдена реальная причина ошибок: неверное объявление API-функций в FPC с параметром riid:REFIID

Delphi , Синтаксис , API реализация

Проблема с определением REFIID в Free Pascal и Delphi

Введение

В процессе работы с Windows API в Free Pascal и Delphi разработчики могут столкнуться с неочевидной проблемой, связанной с определением типа REFIID. Эта проблема была поднята на форуме и заслуживает детального рассмотрения, так как может быть источником скрытых ошибок в коде, работающем с COM-интерфейсами.

Что такое REFIID?

REFIID - это тип, широко используемый в Windows API, особенно при работе с COM-интерфейсами. Согласно документации Microsoft (MSDN), REFIID определяется в C++ как:

typedef IID* REFIID;

То есть, REFIID - это указатель на IID (Interface Identifier), который, в свою очередь, эквивалентен GUID (Globally Unique Identifier).

Проблема в Free Pascal

В файле redef.inc Free Pascal мы видим следующее определение:

type
  PIID    = PGUID;
  TIID    = TGUID;
  REFIID  = TIID;  // Проблемное место
  THANDLE = HANDLE;

Здесь REFIID определяется как TIID, который является TGUID, а не как указатель на TGUID, что противоречит определению Microsoft.

Почему это проблема?

1. Несоответствие спецификации: Определение в Free Pascal не соответствует официальной документации Microsoft.
2. Проблемы с передачей параметров: Когда REFIID используется как параметр функции без модификаторов const, var или constref, передается значение GUID, а не указатель на него.
3. Потенциальные ошибки в структурах: Если REFIID используется в записи (record), это приведет к хранению значения GUID вместо указателя.

Пример проблемного кода

Рассмотрим пример из shlobj.pp:

ICategoryProvider = interface(IUnknown)
  ['{9af64809-5864-4c26-a720-c1f78c086ee3}']
  function CreateCategory(pguid: pGUID; riid: REFIID; ppv: Ppointer): HRESULT; StdCall;
end;

Здесь параметр riid объявлен как REFIID (то есть TGUID), но должен быть указателем на GUID. В C++ эквивалент был бы REFIID riid (что означает IID* riid).

Решения проблемы

1. Исправление определения REFIID

Правильным решением было бы изменить определение:

type
  REFIID = PIID;  // Теперь REFIID - указатель на IID

2. Использование модификаторов параметров

Для существующего определения можно использовать модификаторы:

function CreateCategory(pguid: pGUID; const riid: REFIID; ppv: Ppointer): HRESULT; StdCall;

Модификатор const заставит компилятор передавать параметр по ссылке (как указатель).

3. Альтернативный подход - явное использование указателей

Можно вообще избежать использования REFIID и работать напрямую с указателями:

function CreateCategory(pguid: pGUID; riid: PIID; ppv: Ppointer): HRESULT; StdCall;

Практический пример

Рассмотрим пример корректной работы с COM-интерфейсом:

procedure TestCOMInterface;
var
  CategoryProvider: ICategoryProvider;
  Guid: TGUID;
  Unk: IUnknown;
  HR: HRESULT;
begin
  // Инициализация GUID
  Guid := StringToGUID('{000214F2-0000-0000-C000-000000000046}'); // Пример GUID

  // Получение экземпляра интерфейса
  HR := CoCreateInstance(CLSID_ShellLink, nil, CLSCTX_INPROC_SERVER, 
    IID_ICategoryProvider, CategoryProvider);

  if Succeeded(HR) then
  begin
    // Корректный вызов с передачей указателя на GUID
    HR := CategoryProvider.CreateCategory(@Guid, @IID_IUnknown, @Unk);
    if Succeeded(HR) then
    begin
      // Работа с интерфейсом
    end;
  end;
end;

Рекомендации для разработчиков

1. Проверяйте объявления: При использовании Windows API функций, работающих с REFIID, проверяйте, как объявлен этот параметр.
2. Используйте модификаторы: Если REFIID объявлен как TGUID, добавляйте модификатор const к параметру.
3. Создавайте обертки: Для проблемных функций можно создать обертки с правильными объявлениями.
4. Тестируйте: Особенно тщательно тестируйте код, работающий с COM-интерфейсами.

Заключение

Обнаруженная проблема с определением REFIID в Free Pascal - это пример того, как несоответствие спецификациям может привести к потенциальным ошибкам. Хотя в большинстве случаев код может работать корректно благодаря особенностям передачи параметров, такое определение создает почву для трудноуловимых ошибок.

Разработчикам, работающим с COM-интерфейсами в Free Pascal и Delphi, следует обращать особое внимание на подобные нюансы и при необходимости корректировать объявления функций для соответствия официальной документации Microsoft.

Создано по материалам из источника по ссылке.

Проблема с определением REFIID в Free Pascal и Delphi заключается в несоответствии его реализации официальной спецификации Microsoft, что может вызывать ошибки при работе с COM-интерфейсами.

Комментарии и вопросы

Получайте свежие новости и обновления по Object Pascal, Delphi и Lazarus прямо в свой смартфон. Подпишитесь на наш Telegram-канал delphi_kansoftware и будьте в курсе последних тенденций в разработке под Linux, Windows, Android и iOS

:: Главная :: API реализация ::