Win32 API 日本語リファレンス
ホーム › UI.Shell › ITravelLog

ITravelLog

COM
📘 Microsoft Learn (日本語) · English
IID66a9cb08-4802-11d2-a561-00a0c92dbfe8継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

非推奨。ブラウザーでの移動(travel)の記録を保持および操作するためのメソッドを公開します。

メソッド 11

vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。

vtbl 3 HRESULT AddEntry(IUnknown* punk, BOOL fIsLocalAnchor)

非推奨。保留中のナビゲーションに対応する新しいエントリを travel log に追加します。

punkIUnknown*inoptionalログを生成する移動が行われている、最も近いブラウザーまたはフレームを表す IUnknown へのポインター。
fIsLocalAnchorBOOLin

新しいエントリがローカルアンカーであるかどうかを指定する値。

TRUE

エントリは同一ページ内のアンカーリンクです。

FALSE

エントリは別のページ、または別のページ内のアンカーです。

戻り値

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

vtbl 4 HRESULT UpdateEntry(IUnknown* punk, BOOL fIsLocalAnchor)

非推奨。保留中のナビゲーションに備えて、現在のエントリのブラウザー状態を保存します。

punkIUnknown*inoptionalログを生成する移動が行われている、最も近いブラウザーまたはフレームを表す IUnknown へのポインター。
fIsLocalAnchorBOOLin

新しいエントリがローカルアンカーであるかどうかを指定する値。

TRUE

エントリは同一ページ内のアンカーリンクです。

FALSE

エントリは別のページ、または別のページ内のアンカーです。

戻り値

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

vtbl 5 HRESULT UpdateExternal(IUnknown* punk, IUnknown* punkHLBrowseContext)

非推奨。IHlinkFrame を通じて現在のプロシージャの外部から発生したエントリを更新します。

punkIUnknown*inoptionalログを生成する移動が行われている、最も近いブラウザーまたはフレームを表す IUnknown へのポインター。
punkHLBrowseContextIUnknown*inoptionalIHlinkFrame::GetBrowseContext を通じて取得した IHlinkBrowseContext の IUnknown へのポインター。

戻り値

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

vtbl 6 HRESULT Travel(IUnknown* punk, INT iOffset)

非推奨。現在のエントリの位置を基準として、相対的な位置にある travel log 内の移動エントリへナビゲートします。

punkIUnknown*inoptionalログを生成する移動が行われている、最も近いブラウザーまたはフレームを表す IUnknown へのポインター。
iOffsetINTintravel log 内で移動する、前方(正の値)または後方(負の値)への移動エントリの数。

戻り値

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

ITravelLog::Travel を呼び出すことは、Invoke を呼び出すことと同じ結果になります。

vtbl 7 HRESULT GetTravelEntry(IUnknown* punk, INT iOffset, ITravelEntry** ppte)

非推奨。現在のエントリの位置を基準として、相対的な位置にある travel log 内の移動エントリを取得します。

punkIUnknown*inログを生成する移動が行われている、最も近いブラウザーまたはフレームを表す IUnknown へのポインター。
iOffsetINTintravel log 内で移動する、前方(正の値)または後方(負の値)への移動エントリの数。
ppteITravelEntry**outoptionaliOffset で指定されたオフセットにある移動エントリを表す ITravelEntry インターフェイスへのポインターのアドレス。この値は、メソッドが正常に返された場合にのみ有効です。

戻り値

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

ITravelLog::GetTravelEntry は、ブラウザーウィンドウで 戻る ボタンと 進む ボタンを有効にすべきかどうかを判定するためによく使用されます。

vtbl 8 HRESULT FindTravelEntry(IUnknown* punk, ITEMIDLIST* pidl, ITravelEntry** ppte)

非推奨。特定の移動エントリが travel log 内に存在するかどうかを判定します。

punkIUnknown*inoptionalログを生成する移動が行われている、最も近いブラウザーまたはフレームを表す IUnknown へのポインター。
pidlITEMIDLIST*in移動エントリの PIDL。通常は GetPidl を通じて取得されます。
ppteITravelEntry**out移動エントリが見つかった場合に、それを表す ITravelEntry インターフェイスへのポインターのアドレス。

戻り値

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

vtbl 9 HRESULT GetToolTipText(IUnknown* punk, INT iOffset, INT idsTemplate, LPWSTR pwzText, DWORD cchText)

非推奨。移動エントリのツールチップテキストを取得します。これは UI で Unicode の表示文字列として使用されます。

punkIUnknown*inoptionalログを生成する移動が行われている、最も近いブラウザーまたはフレームを表す IUnknown へのポインター。
iOffsetINTinテキストを取得する対象の移動エントリに到達するために、travel log 内で移動する、前方(正の値)または後方(負の値)への移動エントリの数。
idsTemplateINTin使用されません。
pwzTextLPWSTRoutUnicode のツールチップテキスト文字列を受け取るバッファーへのポインター。
cchTextDWORDinpwzText が指すバッファー内の文字数。

戻り値

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

vtbl 10 HRESULT InsertMenuEntries(IUnknown* punk, HMENU hmenu, INT nPos, INT idFirst, INT idLast, DWORD dwFlags)

非推奨。指定されたメニューにエントリを挿入します。

punkIUnknown*inoptionalログを生成する移動が行われている、最も近いブラウザーまたはフレームを表す IUnknown へのポインター。
hmenuHMENUinメニューのハンドル。
nPosINTinエントリを挿入するメニュー内の位置。
idFirstINTin挿入する最初のエントリの ID。
idLastINTin挿入する最後のエントリの ID。idFirst と idLast の差が、メニューに挿入できるエントリの最大数となります。
dwFlagsDWORDin

メニューに追加するエントリの種類。以下が含まれます。

TLMENUF_INCLUDECURRENT

現在のページを含めます。

TLMENUF_CHECKCURRENT

現在のページのエントリの横にチェックマークを追加します。

TLMENUF_BACK

既定。前のページ群。

TLMENUF_FORE

次のページ群。

TLMENUF_BACKANDFORTH

前、現在、および次のページ群。

戻り値

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

vtbl 11 HRESULT Clone(ITravelLog** pptl)

非推奨。現在の travel log の内容を複製します。

pptlITravelLog**out複製された travel log を表すインターフェイスへのポインターのアドレス。

戻り値

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

vtbl 12 DWORD CountEntries(IUnknown* punk)

非推奨。travel log 内のエントリ数を生成します。

punkIUnknown*inログを生成する移動が行われている、最も近いブラウザーまたはフレームを表す IUnknown へのポインター。

戻り値

型: DWORD

travel log 内のエントリ数。

vtbl 13 HRESULT Revert()

非推奨。現在のエントリに戻し、ナビゲーションが失敗した場合には ITravelLog::AddEntry の結果を破棄します。

戻り値

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

HSP用 COM定義

#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。

出力引数: 
#define global IID_ITravelLog "{66A9CB08-4802-11D2-A561-00A0C92DBFE8}"
#usecom global ITravelLog IID_ITravelLog "{}"
#comfunc global ITravelLog_AddEntry           3 sptr,int
#comfunc global ITravelLog_UpdateEntry        4 sptr,int
#comfunc global ITravelLog_UpdateExternal     5 sptr,sptr
#comfunc global ITravelLog_Travel             6 sptr,int
#comfunc global ITravelLog_GetTravelEntry     7 sptr,int,sptr
#comfunc global ITravelLog_FindTravelEntry    8 sptr,var,sptr
#comfunc global ITravelLog_GetToolTipText     9 sptr,int,int,var,int
#comfunc global ITravelLog_InsertMenuEntries  10 sptr,sptr,int,int,int,int
#comfunc global ITravelLog_Clone              11 sptr
#comfunc global ITravelLog_CountEntries       12 sptr
#comfunc global ITravelLog_Revert             13
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。