ホーム › UI.Controls.RichEdit › ITextStoryRanges

ITextStoryRanges

COMIDispatch (デュアル)

✅ IDispatch を実装(デュアルインターフェース)。HSP では comobj 経由でメソッド名による遅延バインド呼び出しができます(vtableインデックス不要)。

IID8cc497c5-a1df-11ce-8098-00aa0047be5d継承元IDispatch呼び出し名前(IDispatch) または vtbl自前メソッド開始 vtbl7

公式ドキュメント

ITextStoryRanges インターフェイスの目的は、ITextDocument 内のストーリーを列挙することです。

解説(Remarks)

ITextStoryRanges コレクションへのポインターは、GetStoryRanges メソッドを呼び出して取得します。このコレクションから取得した各ストーリーは、ストーリー全体を対象とする ITextRange オブジェクトで表されます。ストーリーを 1 つしか持たない Text Object Model (TOM) エンジンでは、ITextStoryRanges インターフェイスを実装する必要はありません。GetStoryCount が 1 より大きいストーリー数を返す場合にのみ、コードでストーリーのコレクションを取得してください。

メソッド 3

vtbl = vtable インデックス(0始まり)。IDispatch 実装のため HSP ではメソッド名でも呼べます(上記)。低レベルの index 呼び出し用に vtbl も掲載。0〜2 は IUnknown。

vtbl 7 HRESULT _NewEnum(IUnknown** ppunkEnum)

このストーリーのコレクションに対する IEnumVARIANT 列挙子インターフェイスを取得します。

ppunkEnum

IUnknown**

out

列挙子インターフェイスへのポインター。

戻り値

Type: HRESULT

メソッドが成功した場合は S_OK を返します。失敗した場合は、次のいずれかのエラーコードを返します。COM のエラーコードの詳細については、Error Handling in COM を参照してください。

リターンコード	説明
E_INVALIDARG	ppunkEnum が null です。
E_FAIL	その他の理由による失敗。

解説(Remarks)

この定義と IEnumVARIANT の実装を組み合わせることで、次の Microsoft Visual Basic for Applications (VBA) コードをサポートできるようになります。

    Dim t As ITextDocument
    Dim c As ITextStoryRanges
    Dim r As ITextRange

    Set t = gObj
    Set c = t.StoryRanges

    For Each r In c
        Debug.Print r.Text
    Next

vtbl 8 HRESULT Item(INT Index, ITextRange** ppRange)

このストーリーコレクション内の Index 番目のストーリーに対する ITextRange オブジェクトを取得します。

Index	INT	in	取得するストーリー範囲のインデックス。既定値は 1 で、コレクション内の最初のストーリーを示します。ITextStoryRanges::GetCount で得られる Count は、コレクション内の最後のストーリーを示します。Index が 0 未満の場合、ストーリーは最後から最初に向かって数えられ、-1 がコレクション内の最後のストーリーのインデックスとなり、 Index = - Count がコレクション内の最初のストーリーを示します。
ppRange	ITextRange**	out	ITextRange オブジェクト。

戻り値

Type: HRESULT

このメソッドは HRESULT 値を返します。メソッドが成功した場合は S_OK を返します。失敗した場合は、次のいずれかのエラーコードを返します。COM のエラーコードの詳細については、Error Handling in COM を参照してください。

リターンコード	説明
E_INVALIDARG	ppRange が null であるか、Index が範囲外です。
E_FAIL	その他の理由による失敗。

vtbl 9 HRESULT GetCount(INT* pCount)

指定したストーリーコレクション内のストーリーの数を取得します。

pCount

INT*

out

ストーリーの数。

戻り値

Type: HRESULT

このメソッドは S_OK を返します。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_ITextStoryRanges "{8CC497C5-A1DF-11CE-8098-00AA0047BE5D}"
#usecom global ITextStoryRanges IID_ITextStoryRanges "{}"
#comfunc global ITextStoryRanges__NewEnum  7 sptr
#comfunc global ITextStoryRanges_Item      8 int,sptr
#comfunc global ITextStoryRanges_GetCount  9 var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。#define global IID_ITextStoryRanges "{8CC497C5-A1DF-11CE-8098-00AA0047BE5D}"
#usecom global ITextStoryRanges IID_ITextStoryRanges "{}"
#comfunc global ITextStoryRanges__NewEnum  7 sptr
#comfunc global ITextStoryRanges_Item      8 int,sptr
#comfunc global ITextStoryRanges_GetCount  9 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。