Função DdeQueryStringA (ddeml.h)

Artigo
03/05/2024

Copia o texto associado a um identificador de cadeia de caracteres em um buffer.

Sintaxe

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

Parâmetros

[in] idInst

Tipo: DWORD

O identificador de instância do aplicativo obtido por uma chamada anterior para a função DdeInitialize .

[in] hsz

Tipo: HSZ

Um identificador para a cadeia de caracteres a ser copiada. Esse identificador deve ter sido criado por uma chamada anterior para a função DdeCreateStringHandle .

[out, optional] psz

Tipo: LPTSTR

Um ponteiro para um buffer que recebe a cadeia de caracteres. Para obter o comprimento da cadeia de caracteres, esse parâmetro deve ser definido como NULL.

[in] cchMax

Tipo: DWORD

O comprimento, em caracteres, do buffer apontado pelo parâmetro psz . Para a versão ANSI da função , esse é o número de bytes; para a versão Unicode, esse é o número de caracteres. Se a cadeia de caracteres for maior que ( cchMax– 1), ela será truncada. Se o parâmetro psz for definido como NULL, esse parâmetro será ignorado.

[in] iCodePage

Tipo: int

A página de código usada para renderizar a cadeia de caracteres. Esse valor deve ser CP_WINANSI ou CP_WINUNICODE.

Retornar valor

Tipo: DWORD

Se o parâmetro psz especificou um ponteiro válido, o valor retornado será o comprimento, em caracteres, do texto retornado (sem incluir o caractere nulo de terminação). Se o parâmetro psz especificou um ponteiro NULL , o valor retornado será o comprimento do texto associado ao parâmetro hsz (sem incluir o caractere nulo de terminação). Se ocorrer um erro, o valor retornado será 0L.

Comentários

A cadeia de caracteres retornada no buffer é sempre terminada em nulo. Se a cadeia de caracteres for maior que ( cchMax– 1), somente os primeiros caracteres ( cchMax– 1) da cadeia de caracteres serão copiados.

Se o parâmetro psz for NULL, a função DdeQueryString obterá o comprimento, em bytes, da cadeia de caracteres associada ao identificador de cadeia de caracteres. O comprimento não inclui o caractere nulo de terminação.

Observação

O cabeçalho ddeml.h define DdeQueryString como um alias que seleciona automaticamente a versão ANSI ou Unicode dessa função com base na definição da constante de pré-processador UNICODE. Misturar o uso do alias neutro de codificação com código que não seja neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Convenções para protótipos de função.

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows 2000 Professional [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows 2000 Server [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	ddeml.h (inclua Windows.h)
Biblioteca	User32.lib
DLL	User32.dll