Функция DdeQueryStringA (ddeml.h)

Статья
08/23/2023

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

Синтаксис

DWORD DdeQueryStringA(
  [in]            DWORD idInst,
  [in]            HSZ   hsz,
  [out, optional] LPSTR psz,
  [in]            DWORD cchMax,
  [in]            int   iCodePage
);

Параметры

[in] idInst

Тип: DWORD

Идентификатор экземпляра приложения, полученный при предыдущем вызове функции DdeInitialize .

[in] hsz

Тип: HSZ

Дескриптор копируемой строки. Этот дескриптор должен быть создан при предыдущем вызове функции DdeCreateStringHandle .

[out, optional] psz

Тип: LPTSTR

Указатель на буфер, получающий строку. Чтобы получить длину строки, этому параметру необходимо задать значение NULL.

[in] cchMax

Тип: DWORD

Длина (в символах) буфера, на который указывает параметр psz . Для версии ANSI функции это число байтов; Для версии Юникода это число символов. Если строка длиннее ( cchMax–1), она будет усечена. Если параметру psz присвоено значение NULL, этот параметр игнорируется.

[in] iCodePage

Тип: int

Кодовая страница, используемая для отрисовки строки. Это значение должно быть либо CP_WINANSI , либо CP_WINUNICODE.

Возвращаемое значение

Тип: DWORD

Если параметр psz указал допустимый указатель, возвращаемое значение представляет собой длину возвращаемого текста в символах (не включая завершающий пустой символ). Если в параметре psz указан указатель NULL , возвращаемое значение представляет собой длину текста, связанного с параметром hsz (не включая завершающий символ NULL). При возникновении ошибки возвращается значение 0L.

Заголовок ddeml.h определяет DdeQueryString в качестве псевдонима, который автоматически выбирает версию ANSI или Юникод этой функции на основе определения константы препроцессора UNICODE. Сочетание использования псевдонима, не зависящий от кодировки, с кодом, не зависящим от кодировки, может привести к несоответствиям, которые приводят к ошибкам компиляции или среды выполнения. Дополнительные сведения см. в разделе Соглашения для прототипов функций.

Требования

Требование	Значение
Минимальная версия клиента	Windows 2000 Professional [только классические приложения]
Минимальная версия сервера	Windows 2000 Server [только классические приложения]
Целевая платформа	Windows
Header	ddeml.h (включая Windows.h)
Библиотека	User32.lib
DLL	User32.dll