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 値を任意に組み合わせて使用できます。

[in] str

型: ASSOCSTR

返される文字列の型を指定する ASSOCSTR 値。

[in, optional] pszExtra

種類: LPCWSTR

文字列の場所に関する情報を含む、null で終わるオプションの Unicode 文字列へのポインター。 通常、これは open などのシェル動詞に設定 されます。 このパラメーターを使用しない場合は NULL に 設定します。

[out, optional] pszOut

種類: LPWSTR

要求された文字列を返すために使用される null で終わる Unicode 文字列へのポインター。 必要なバッファー サイズを取得するには、このパラメーターを NULL に設定します。

[in, out] pcchOut

型: DWORD*

入力時に pwszOut バッファー内の文字数に設定される値へのポインター。 関数が正常に返されると、バッファーに配置された文字数を指します。

ASSOCF_NOTRUNCATE フラグが flags に設定されていて、pwszOut で指定されたバッファーが小さすぎる場合、関数は E_POINTERを返し、pcchOut はバッファーの必要なサイズを指します。

pwszOut が NULL の場合、関数は S_FALSEを返し、pcchOut はバッファーの必要なサイズを指します。

戻り値

型: HRESULT

次のような標準 COM エラー値を返します。

エラー 説明
S_OK 正常終了しました。
E_POINTER pwszOut バッファーが小さすぎて文字列全体を保持できません。
S_FALSE pwszOut は NULL です。 pcchOut には、必要なバッファー サイズが含まれています。

要件

要件 値
サポートされている最小のクライアント Windows 2000 Professional、Windows XP [デスクトップ アプリのみ]
サポートされている最小のサーバー Windows 2000 Server [デスクトップ アプリのみ]
対象プラットフォーム Windows
ヘッダー shlwapi.h
Library Shlwapi.lib
[DLL] Shell32.dll (バージョン 5.0 以降)