Función DdeQueryStringA (ddeml.h)

Artículo
08/23/2023

Copia el texto asociado a un identificador de cadena en un búfer.

Sintaxis

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

Parámetros

[in] idInst

Tipo: DWORD

Identificador de instancia de aplicación obtenido por una llamada anterior a la función DdeInitialize .

[in] hsz

Tipo: HSZ

Identificador de la cadena que se va a copiar. Este identificador debe haberse creado mediante una llamada anterior a la función DdeCreateStringHandle .

[out, optional] psz

Tipo: LPTSTR

Puntero a un búfer que recibe la cadena. Para obtener la longitud de la cadena, este parámetro debe establecerse en NULL.

[in] cchMax

Tipo: DWORD

Longitud, en caracteres, del búfer al que apunta el parámetro psz . Para la versión ANSI de la función, este es el número de bytes; para la versión Unicode, este es el número de caracteres. Si la cadena es mayor que ( cchMax– 1), se truncará. Si el parámetro psz se establece en NULL, este parámetro se omite.

[in] iCodePage

Tipo: int

Página de códigos utilizada para representar la cadena. Este valor debe ser CP_WINANSI o CP_WINUNICODE.

Valor devuelto

Tipo: DWORD

Si el parámetro psz especificó un puntero válido, el valor devuelto es la longitud, en caracteres, del texto devuelto (sin incluir el carácter nulo de terminación). Si el parámetro psz especificó un puntero NULL , el valor devuelto es la longitud del texto asociado al parámetro hsz (sin incluir el carácter nulo de terminación). Si se produce un error, el valor devuelto es 0L.

Comentarios

La cadena devuelta en el búfer siempre termina en null. Si la cadena es mayor que ( cchMax– 1), solo se copian los primeros caracteres ( cchMax– 1) de la cadena.

Si el parámetro psz es NULL, la función DdeQueryString obtiene la longitud, en bytes, de la cadena asociada al identificador de cadena. La longitud no incluye el carácter nulo de terminación.

Nota

El encabezado ddeml.h define DdeQueryString como alias que selecciona automáticamente la versión ANSI o Unicode de esta función en función de la definición de la constante de preprocesador UNICODE. La combinación del uso del alias neutral de codificación con código que no es neutral de codificación puede dar lugar a errores de coincidencia que dan lugar a errores de compilación o tiempo de ejecución. Para obtener más información, vea Convenciones para prototipos de función.

Requisitos

Requisito	Value
Cliente mínimo compatible	Windows 2000 Professional [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows 2000 Server [solo aplicaciones de escritorio]
Plataforma de destino	Windows
Encabezado	ddeml.h (incluye Windows.h)
Library	User32.lib
Archivo DLL	User32.dll