PSStringFromPropertyKey 函式 (propsys.h)

  • 發行項

建立字串，從該屬性的索引鍵識別屬性。

語法

PSSTDAPI PSStringFromPropertyKey(
  [in]  REFPROPERTYKEY pkey,
  [out] LPWSTR         psz,
  [in]  UINT           cch
);

參數

[in] pkey

類型： REFPROPERTYKEY

識別屬性之 PROPERTYKEY 結構的參考。

[out] psz

類型： LPWSTR

接收輸出字串之緩衝區的指標。 緩衝區應該夠大，足以包含PKEYSTR_MAX WCHARs。

[in] cch

類型： UINT

psz 所指向的緩衝區長度，在 WCHARs 中。

傳回值

類型： HRESULT

如果此函式成功，則會傳回 S_OK。 否則，它會傳回 HRESULT 錯誤碼。

備註

擷取的字串格式為 "{propkey.fmtid} propkey.pid"。 例如，輸出 PKEY_Title 字串為 "{F29F85E0-4FF9-1068-AB91-08002B27B3D9} 2"。

範例

下列範例會示範 PSPropertyKeyFromString 的使用方式，作為較大程式的一部分。

WCHAR szKey[PKEYSTR_MAX]

HRESULT hr = PSStringFromPropertyKey(PKEY_Title, szKey, ARRAYSIZE(szKey));

if (SUCCEEDED(hr))
{
    // szKey is now valid.
}

規格需求

需求 值
最低支援的用戶端 Windows XP 搭配 SP2、Windows Vista [僅限傳統型應用程式]
最低支援的伺服器 Windows Server 2003 SP1 [僅限傳統型應用程式]
目標平台 Windows
標頭 propsys.h
程式庫 Propsys.lib
Dll Propsys.dll (6.0 版或更新版本)
可轉散發套件 Windows 桌面搜尋 (WDS) 3.0

另請參閱

PSGetNameFromPropertyKey

PSPropertyKeyFromString