Share via


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)
程式庫 User32.lib
Dll User32.dll
API 集合 ext-ms-win-ntuser-misc-l1-1-0 (於 Windows 8)

另請參閱

剪貼簿

概念

EnumClipboardFormats

參考

RegisterClipboardFormat