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

Статья
11/20/2024

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

Синтаксис

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 указал допустимый указатель, возвращаемое значение является длиной в символах возвращаемого текста (не включая конечный символ NULL). Если параметр psz указал указатель NULL, то возвращаемое значение — это длина текста, связанного с параметром hsz (не включая конечный символ NULL). Если возникает ошибка, возвращаемое значение равно 0L.

Замечания

Строка, возвращаемая в буфере, всегда завершается значением NULL. Если строка длиннее (cchMax– 1), копируются только первые (cchMax– 1) строк.

Если параметр psz имеет значение NULL, функция DdeQueryString получает длину в байтах строки, связанной с дескриптором строки. Длина не включает завершающий символ NULL.

Заметка

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

Требования

Требование	Ценность
минимальные поддерживаемые клиентские	Windows 2000 Профессиональный [только классические приложения]
минимальный поддерживаемый сервер	Windows 2000 Server [только классические приложения]
целевая платформа	Виндоус
заголовка	ddeml.h (include Windows.h)
библиотеки	User32.lib
DLL	User32.dll