Win32 API 日本語リファレンス
ホームStorage.Xps › IXpsOMImageResource

IXpsOMImageResource

COM
IID3db8417d-ae50-485e-9a44-d7758f78a23f継承元IXpsOMResource自前メソッド開始 vtbl5

公式ドキュメント

画像リソースへの IStream インターフェイスを提供します。

解説(Remarks)

次のコード例は、このインターフェイスのインスタンスを作成する方法を示しています。


IXpsOMImageResource    *newInterface;
// The following values are defined outside of 
// this example.
//  IStream            *acquiredStream;
//  XPS_IMAGE_TYPE     contentType;
//  IOpcPartUri        *partUri;
    
// Note the implicit requirement that CoInitializeEx 
//  has previously been called from this thread.

hr = CoCreateInstance(
    __uuidof(XpsOMObjectFactory),
    NULL,
    CLSCTX_INPROC_SERVER,
    _uuidof(IXpsOMObjectFactory),
    reinterpret_cast<LPVOID*>(&xpsFactory)
    );

if (SUCCEEDED(hr))
{
    // The partUriString and acquiredStream variables 
    //   are defined outside of this example.
    hr = xpsFactory->CreatePartUri(partUriString, &partUri);
    if (SUCCEEDED(hr))
    {
        hr = xpsFactory->CreateImageResource (
            acquiredStream,
            contentType,
            partUri,
            &newInterface);
        if (SUCCEEDED(hr))
        {
            // use newInterface

            newInterface->Release();
        }
        partUri->Release();
    }
    xpsFactory->Release();
}
else
{
    // evaluate HRESULT error returned in hr
}

メソッド 3

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

vtbl 5 HRESULT GetStream(IStream** readerStream)

このリソースに関連付けられているストリームの、新しい読み取り専用のコピーを取得します。(IXpsOMImageResource.GetStream)

readerStreamIStream**outこのリソースに関連付けられているストリームの、新しい読み取り専用のコピー。

戻り値

メソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。XPS ドキュメント API の戻り値については、XPS Document Errors を参照してください。

このメソッドは Packaging API を呼び出します。Packaging API の戻り値については、Packaging Errors を参照してください。

解説(Remarks)

このメソッドが返す IStream オブジェクトは、E_PENDING エラーを返す場合があります。これは、ストリームの長さがまだ確定していないことを示します。この動作は、標準の IStream オブジェクトの動作とは異なります。

このメソッドは、stream で返されるストリームを作成するために、ストリームの Clone メソッドを呼び出します。そのため、このメソッドのパフォーマンスは、ストリームの Clone メソッドのパフォーマンスに依存します。

vtbl 6 HRESULT SetContent(IStream* sourceStream, XPS_IMAGE_TYPE imageType, IOpcPartUri* partName)

このリソースに関連付ける読み取り専用ストリームを設定します。(IXpsOMImageResource.SetContent)

sourceStreamIStream*inこのリソースに関連付ける読み取り専用ストリーム。
imageTypeXPS_IMAGE_TYPEinストリーム内の画像の種類を表す XPS_IMAGE_TYPE 値。
partNameIOpcPartUri*inこのリソースに割り当てるパート名。

戻り値

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

解説(Remarks)

呼び出し側のメソッドは、このストリームをシングルスレッドアパートメント (STA) モデルのオブジェクトとして扱い、ストリームインターフェイスのいずれのメソッドにも再入しないようにする必要があります。

GetStream はこのメソッドで設定されたストリームのクローンを取得するため、指定するストリームには効率的なクローン作成メソッドが必要です。クローン作成メソッドが非効率なストリームは、GetStream のパフォーマンスを低下させます。

vtbl 7 HRESULT GetImageType(XPS_IMAGE_TYPE* imageType)

画像リソースの種類を取得します。

imageTypeXPS_IMAGE_TYPE*outストリーム内の画像の種類を表す XPS_IMAGE_TYPE 値。

戻り値

メソッドが成功した場合は 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_IXpsOMImageResource "{3DB8417D-AE50-485E-9A44-D7758F78A23F}"
#usecom global IXpsOMImageResource IID_IXpsOMImageResource "{}"
#comfunc global IXpsOMImageResource_GetStream     5 sptr
#comfunc global IXpsOMImageResource_SetContent    6 sptr,int,sptr
#comfunc global IXpsOMImageResource_GetImageType  7 var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。