IQueryAssociations：：GetString 方法 (shlwapi.h)

從登錄搜尋並擷取檔案或通訊協定關聯相關字串。

語法

HRESULT GetString(
  [in]            ASSOCF   flags,
  [in]            ASSOCSTR str,
  [in, optional]  LPCWSTR  pszExtra,
  [out, optional] LPWSTR   pszOut,
  [in, out]       DWORD    *pcchOut
);

參數

[in] flags

類型： ASSOCF

可用來控制搜尋的旗標。 它可以是下列 ASSOCF 值的任何組合。

• ASSOCF_IGNOREBASECLASS
• ASSOCF_NOFIXUPS
• ASSOCF_NOTRUNCATE
• ASSOCF_NOUSERSETTINGS
• ASSOCF_REMAPRUNDLL
• ASSOCF_VERIFY

[in] str

類型： ASSOCSTR

ASSOCSTR 值，指定要傳回的字串類型。

[in, optional] pszExtra

類型： LPCWSTR

選擇性、以 Null 結尾的 Unicode 字串指標，其中包含字串位置的相關信息。 它通常會設定為Shell動詞，例如 open。 如果未使用此參數，請將此參數設定為 NULL 。

[out, optional] pszOut

類型： LPWSTR

用來傳回所要求字串之 Null 終止 Unicode 字串的指標。 將此參數設定為 NULL ，以擷取所需的緩衝區大小。

[in, out] pcchOut

類型： DWORD*

在專案上，值的指標會設定為 pwszOut 緩衝區中的字元數。 當函式成功傳回時，它會指向緩衝區中放置的字元數。

如果 ASSOCF_NOTRUNCATE 旗標是在 旗 標中設定，而 pwszOut 中指定的緩衝區太小，則函式會傳回E_POINTER， 而pcchOut 會指向所需的緩衝區大小。

如果 pwszOut 為 NULL，函式會傳回S_FALSE， 而 pcchOut 會 指向緩衝區的必要大小。

傳回值

類型： HRESULT

傳回標準 COM 錯誤值，包括下列專案：

錯誤	意義
S_OK	成功。
E_POINTER	pwszOut 緩衝區太小，無法保存整個字串。
S_FALSE	pwszOut 為 NULL。 pcchOut 包含所需的緩衝區大小。

規格需求

需求	值
最低支援的用戶端	Windows 2000 專業版、Windows XP [僅限傳統型應用程式]
最低支援的伺服器	Windows 2000 Server [僅限傳統型應用程式]
目標平台	Windows
標頭	shlwapi.h
程式庫	Shlwapi.lib
Dll	Shell32.dll (5.0 版或更新版本)