Función GetClipboardFormatNameA (winuser.h)

Recupera del Portapapeles el nombre del formato registrado especificado. La función copia el nombre en el búfer especificado.

Sintaxis

int GetClipboardFormatNameA(
  [in]  UINT  format,
  [out] LPSTR lpszFormatName,
  [in]  int   cchMaxCount
);

Parámetros

[in] format

Tipo: UINT

Tipo de formato que se va a recuperar. Este parámetro no debe especificar ninguno de los formatos predefinidos del Portapapeles.

[out] lpszFormatName

Tipo: LPTSTR

Búfer que va a recibir el nombre del formato.

[in] cchMaxCount

Tipo: int

Longitud máxima, en caracteres, de la cadena que se va a copiar en el búfer. Si el nombre supera este límite, se trunca.

Valor devuelto

Tipo: int

Si la función se ejecuta correctamente, el valor devuelto es la longitud, en caracteres, de la cadena copiada en el búfer.

Si se produce un error en la función, el valor devuelto es cero, lo que indica que el formato solicitado no existe o está predefinido. Para obtener información de error extendida, llame a GetLastError.

Comentarios

Consideraciones de seguridad

El uso incorrecto de esta función podría poner en peligro la seguridad del programa. Por ejemplo, calcular erróneamente el tamaño adecuado del búfer lpszFormatName , especialmente cuando la aplicación se usa en versiones ANSI y Unicode, puede provocar un desbordamiento del búfer. Además, tenga en cuenta que la cadena se trunca si es más larga que el parámetro cchMaxCount , lo que puede provocar la pérdida de información.

Ejemplos

Para obtener un ejemplo, vea Ejemplo de un Visor de Portapapeles.

Nota

El encabezado winuser.h define GetClipboardFormatName 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 neutro de codificación con código que no es neutral de codificación puede provocar discrepancias que dan lugar a errores de compilación o en 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 (incluya Windows.h)
Library	User32.lib
Archivo DLL	User32.dll
Conjunto de API	ext-ms-win-ntuser-misc-l1-1-0 (introducido en Windows 8)

Consulte también

Portapapeles

Conceptual

EnumClipboardFormats

Referencia

RegisterClipboardFormat