ホーム › Storage.Xps › IXpsOMDocumentSequence

IXpsOMDocumentSequence

COM

IID56492eb4-d8d5-425e-8256-4c2b64ad0264継承元IXpsOMPart自前メソッド開始 vtbl5

公式ドキュメント

XPS ドキュメントのコンテンツを保持するルートオブジェクトです。

解説(Remarks)

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


IXpsOMDocumentSequence    *newInterface;
IOpcPartUri               *partUri;

// このスレッドで CoInitializeEx が事前に呼び出されている必要がある点に
//  暗黙的に依存していることに注意してください。

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

if (SUCCEEDED(hr))
{
    hr = xpsFactory->CreatePartUri(partUriString, &partUri);
    
    if (SUCCEEDED(hr))
    {
        hr = xpsFactory->CreateDocumentSequence (partUri, &newInterface);

        if (SUCCEEDED(hr))
        {
            // newInterface を使用する

            newInterface->Release();
        }
        partUri->Release();
    }
    xpsFactory->Release();
}
else
{
    // hr で返された HRESULT のエラーを評価する
}

メソッド 4

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

vtbl 5 HRESULT GetOwner(IXpsOMPackage** package)

ドキュメントシーケンスを含む IXpsOMPackage インターフェイスへのポインターを取得します。

package

IXpsOMPackage**

out

ドキュメントシーケンスを含む IXpsOMPackage インターフェイスへのポインターです。ドキュメントシーケンスがパッケージに属していない場合は、NULL ポインターが返されます。

戻り値

このメソッドは HRESULT を返します。返される可能性のある値には、次の表に示すものが含まれますが、これらに限定されません。この表に記載されていない XPS ドキュメント API の戻り値については、XPS Document Errors を参照してください。

戻り値	説明
S_OK	メソッドは成功しました。
E_POINTER	package が NULL です。

vtbl 6 HRESULT GetDocuments(IXpsOMDocumentCollection** documents)

ドキュメントシーケンスで指定されたドキュメントを保持する IXpsOMDocumentCollection インターフェイスへのポインターを取得します。

documents

IXpsOMDocumentCollection**

out

ドキュメントシーケンスで指定されたドキュメントを保持する IXpsOMDocumentCollection インターフェイスへのポインターです。シーケンスにドキュメントが 1 つも含まれていない場合、IXpsOMDocumentCollection インターフェイスは空になります。

戻り値

戻り値	説明
S_OK	メソッドは成功しました。
E_POINTER	documents が NULL です。

解説(Remarks)

ドキュメントシーケンスにドキュメントが 1 つも含まれていない場合、documents で返されるドキュメントコレクションは空になります。コレクション内のドキュメント数を取得するには、コレクションの GetCount メソッドを呼び出してください。

vtbl 7 HRESULT GetPrintTicketResource(IXpsOMPrintTicketResource** printTicketResource)

ドキュメントシーケンスに割り当てられたジョブレベルの印刷チケットに対する IXpsOMPrintTicketResource インターフェイスを取得します。

printTicketResource

IXpsOMPrintTicketResource**

out

ドキュメントシーケンスに割り当てられたジョブレベルの印刷チケットの IXpsOMPrintTicketResource インターフェイスへのポインターです。ドキュメントシーケンスに IXpsOMPrintTicketResource インターフェイスが割り当てられていない場合は、NULL ポインターが返されます。

戻り値

戻り値	説明
S_OK	メソッドは成功しました。
E_POINTER	printTicketResource が NULL です。

解説(Remarks)

リソースを読み込んで XPS OM に解析した後、このメソッドが別のリソースに関するエラーを返す場合があります。これは、リソースの読み込み時にすべてのリレーションシップが解析されるためです。

vtbl 8 HRESULT SetPrintTicketResource(IXpsOMPrintTicketResource* printTicketResource)

ドキュメントシーケンスのジョブレベルの印刷チケットリソースを設定します。

printTicketResource

IXpsOMPrintTicketResource*

ドキュメントシーケンスに設定するジョブレベルの印刷チケットの IXpsOMPrintTicketResource インターフェイスへのポインターです。ドキュメントシーケンスが印刷チケットリソースを保持している場合、NULL ポインターを指定するとそのリソースが解放されます。

戻り値

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

解説(Remarks)

このメソッドの呼び出し時にドキュメントが IXpsOMPrintTicketResource インターフェイスを保持している場合、printTicketResource で渡される新しい IXpsOMPrintTicketResource インターフェイスが設定される前に、そのインターフェイスが解放されます。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IXpsOMDocumentSequence "{56492EB4-D8D5-425E-8256-4C2B64AD0264}"
#usecom global IXpsOMDocumentSequence IID_IXpsOMDocumentSequence "{}"
#comfunc global IXpsOMDocumentSequence_GetOwner                5 sptr
#comfunc global IXpsOMDocumentSequence_GetDocuments            6 sptr
#comfunc global IXpsOMDocumentSequence_GetPrintTicketResource  7 sptr
#comfunc global IXpsOMDocumentSequence_SetPrintTicketResource  8 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。