О чём не пишут в книгах по Delphi

Здесь параметр Buf содержит указатель на буфер, выделенный вызывающей программой, BufLen — размер этого буфера в байтах. Для примера здесь взят случай, когда строка, которую нужно возвратить, формируется в переменной типа string, т.к. в большинстве случаев это наиболее удобный способ. После того как строка сформирована, ее содержимое копируется в буфер с учетом его длины. Результат, который возвращает функция, — это необходимый размер буфера. Программа по этому результату может сделать вывод, поместилась ли вся строка в выделенный ей буфер, и если не поместилась, принять меры, например, вызвать функцию еще раз. выделив под буфер больше памяти.

Если не существует ограничения на длину возвращаемой строки, программа "не знает", буфер какого размера потребуется. Наиболее простое решение этой проблемы следующее: программа сначала вызывает функцию GetString, передавая nil в качестве указателя на буфер и 0 в качестве размера буфера. Затем по результату функции определяется требуемый размер буфера, выделяется память и функция вызывается еще раз, уже с буфером нужного размера. Такой способ обеспечивает правильную передачу строки любой длины, но требует двукратного вызова функции, что снижает производительность, особенно в том случае, если на формирование строки тратится много времени.

Повысить среднюю производительность можно, применяя комбинированный метод получения буфера. Программа создает массив в стеке такого размера, чтобы в большинстве случаев возвращаемая строка вмещалась в нем. Этот размер определяется в каждом конкретном случае, исходя из особенностей функции и условий ее вызова. А на тот случай, если она все-таки там не поместилась, предусмотрен запасной вариант с выделением буфера в динамической памяти. Этот подход иллюстрирует листинг 3.45.

Листинг 3.45. Быстрый (в среднем) способ получения строки через буфер

const

 StatBufSize = ...; // Размер, подходящий для данного случая

var

 StatBuf: array[0..StatBufSize - 1] of Char;

 Buf: PChar;

 RealLen: Integer;

begin

 // Пытаемся разместить строку в буфере StatBuf

 RealLen := GetString(StatBuf, StatBufSize);

 if RealLen > StatBufSize then

 begin

  // Если StatBuf оказался слишком мал, динамически выделяем буфер

  // нужного размера и вызываем функции еще раз

  Buf := StrAlloc(RealLen);

  GetString(Buf, RealLen);

 end

 else

  // Размера статического буфера хватило. Пусть Buf указывает

  // на StatBuf, чтобы нижеследующий код мог в любом случае

  // обращаться к буферу через переменную Buf

  Buf := StatBuf;

 // Что-то делаем с содержимым буфера

 ...

 // Если выделяли память, ее следует очистить

 if Buf <> StatBuf then StrDispose(Buf);

end;

Следует также упомянуть о еще одной альтернативе передачи строк в DLL — типе WideString, который хранит строку в кодировке Unicode и является, по сути, оберткой над системным типом BSTR. Работать с WideString так же просто, как и с AnsiString, перекодирование из ANSI в Unicode и обратно выполняется автоматически при присваивании значения одного типа переменной другого. В целях совместимости с СОМ и OLE при работе с памятью дли строк WideString используется специальный системный менеджер памяти (через API-функции SysAllocString, SysFreeString и т.п.), поэтому передавать эти строки из DLL в главный модуль и обратно можно совершенно безопасно даже без ShareMem. Правда, при этом не стоит забывать о расходовании процессорного времени на перекодировку, если основная работа идет не с Unicode, а с ANSI.

Отметим одну ошибку, которую делают новички, прочитавшие комментарий про ShareMem, но не умеющие работать с PChar. Они пишут, например, такой код для функции, находящейся в DLL и возвращающей строку (листинг 3.46).

Листинг 3.46. Неправильный способ возврата строки из DLL

function SomeFunction(...): PChar;

var

 S: string;

begin

 // Здесь присваивается значение S

 Result := PChar(S);

end;