Compartilhar via


Função DdeQueryStringA (ddeml.h)

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 da instância do aplicativo obtido por uma chamada anterior para a função DdeInitialize.

[in] hsz

Tipo: do 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.

Valor de retorno

Tipo: DWORD

Se o parâmetro psz especificar 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 especificar 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.

Observações

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.

Nota

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 do pré-processador UNICODE. A combinação do uso do alias neutro de codificação com código que não é neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Conventions for Function Prototypes.

Requisitos

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

Consulte também

Conceitual

DdeCmpStringHandles

DdeCreateStringHandle

DdeFreeStringHandle

DdeInitialize

da Biblioteca de Gerenciamento dinâmico do Data Exchange

de referência de