GetClipboardFormatNameA 函数 (winuser.h)

  • 项目

从剪贴板检索指定注册格式的名称。 函数将名称复制到指定的缓冲区。

语法

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

参数

[in] format

类型： UINT

要检索的格式的类型。 此参数不得指定任何预定义剪贴板格式。

[out] lpszFormatName

类型： LPTSTR

要接收格式名称的缓冲区。

[in] cchMaxCount

类型： int

要复制到缓冲区的字符串的最大长度（以字符为单位）。 如果名称超出此限制，则会将其截断。

返回值

类型： int

如果函数成功，则返回值是复制到缓冲区的字符串的长度（以字符为单位）。

如果函数失败，则返回值为零，表示请求的格式不存在或已预定义。 要获得更多的错误信息，请调用 GetLastError。

注解

安全注意事项

错误使用此函数可能会危及程序的安全性。 例如，错误计算 lpszFormatName 缓冲区的正确大小（尤其是在 ANSI 和 Unicode 版本中使用应用程序时）可能会导致缓冲区溢出。 另请注意，如果字符串长于 cchMaxCount 参数，则字符串将被截断，这可能导致信息丢失。

示例

有关示例，请参阅 剪贴板查看器的示例。

注意

winuser.h 标头将 GetClipboardFormatName 定义为别名，该别名根据 UNICODE 预处理器常量的定义自动选择此函数的 ANSI 或 Unicode 版本。 将非特定编码别名的使用与非非特定编码的代码混合使用可能会导致不匹配，从而导致编译或运行时错误。 有关详细信息，请参阅 函数原型的约定。

要求

要求 值
最低受支持的客户端 Windows 2000 Professional [仅限桌面应用]
最低受支持的服务器 Windows 2000 Server [仅限桌面应用]
目标平台 Windows
标头 winuser.h (包括 Windows.h)
Library User32.lib
DLL User32.dll
API 集 在 Windows 8) 中引入的 ext-ms-win-ntuser-misc-l1-1-0 (

另请参阅

剪贴板

概念性

EnumClipboardFormats

引用

RegisterClipboardFormat