Función GetDlgItemTextA (winuser.h)

Artículo
08/27/2023

Recupera el título o el texto asociado a un control en un cuadro de diálogo.

Sintaxis

UINT GetDlgItemTextA(
  [in]  HWND  hDlg,
  [in]  int   nIDDlgItem,
  [out] LPSTR lpString,
  [in]  int   cchMax
);

Parámetros

[in] hDlg

Tipo: HWND

Identificador del cuadro de diálogo que contiene el control .

[in] nIDDlgItem

Tipo: int

Identificador del control cuyo título o texto se va a recuperar.

[out] lpString

Tipo: LPTSTR

Búfer que se va a recibir el título o el texto.

[in] cchMax

Tipo: int

Longitud máxima, en caracteres, de la cadena que se va a copiar en el búfer al que apunta lpString. Si la longitud de la cadena, incluido el carácter null, supera el límite, se trunca la cadena.

Valor devuelto

Tipo: UINT

Si la función se ejecuta correctamente, el valor devuelto especifica el número de caracteres copiados en el búfer, sin incluir el carácter nulo de terminación.

Si la función no se realiza correctamente, el valor devuelto es cero. Para obtener información de error extendida, llame a GetLastError.

Comentarios

Si la cadena es tan larga o más larga que el búfer, el búfer contendrá la cadena truncada con un carácter nulo de terminación.

La función GetDlgItemText envía un mensaje WM_GETTEXT al control .

Ejemplos

Para obtener un ejemplo, vea Crear un cuadro de diálogo modal.

Nota

El encabezado winuser.h define GetDlgItemText 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	winuser.h (incluir Windows.h)
Library	User32.lib
Archivo DLL	User32.dll
Conjunto de API	ext-ms-win-ntuser-dialogbox-l1-1-0 (introducido en Windows 8)