IXpsSignatureManager

XPS ドキュメントのデジタル署名およびデジタル署名要求を管理します。

XPS ドキュメントで使用する署名マネージャーを初期化するには、次の例に示すように CoCreateInstance を呼び出して IXpsSignatureManager インターフェイスをインスタンス化します。

IXpsSignatureManager    *newInterface;

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

hr = CoCreateInstance(
    __uuidof(XpsSignatureManager),
    NULL, 
    CLSCTX_INPROC_SERVER,
    __uuidof(IXpsSignatureManager),
    reinterpret_cast<LPVOID*>(&newInterface));

// インターフェイスへのポインターが取得できたことを
// 確認します
if (SUCCEEDED(hr)) {
    // ファイルからドキュメントを署名マネージャーに読み込みます。
    //  xpsDocument には、読み込むドキュメントのファイル名が
    //  この例の外部で設定されています。
    hr = newInterface->LoadPackageFile (xpsDocument);

    // newInterface を使用します

    // 使用が終わったらインターフェイス ポインターを解放します
    newInterface->Release();
}

CoCreateInstance でインスタンス化したインターフェイスは、1 つの XPS ドキュメントに対してのみ使用できます。そのドキュメントは、他のメソッドを呼び出す前に LoadPackageFile または LoadPackageStream を呼び出して読み込む必要があります。

IXpsSignatureManager インターフェイスをインスタンス化し、XPS ドキュメントを読み込むと、署名マネージャーを使用できる状態になります。

既存の XPS パッケージをファイルからデジタル署名マネージャーに読み込みます。

このメソッドは HRESULT を返します。指定できる値には次の表の値が含まれますが、これらに限定されません。この表に記載されていない戻り値については、XPS Digital Signature API Errors および XPS Document Errors を参照してください。

インターフェイスをインスタンス化した後、このインターフェイスの他のメソッドを呼び出す前に、このメソッドまたは LoadPackageStream を呼び出して XPS パッケージを読み込む必要があります。

IXpsSignatureManager のインスタンスに XPS パッケージを読み込んだ後、同じインスタンスで LoadPackageFile または LoadPackageStream を呼び出すと、エラーが返されます。

LoadPackageFile または LoadPackageStream を呼び出した後、同じオブジェクトを別の XPS パッケージ ファイルやストリームに再利用することはできません。別の XPS パッケージを読み込むには、IXpsSignatureManager の新しいインスタンスをインスタンス化する必要があります。

LoadPackageStream は、XPS パッケージのすべての内容を検証するわけではありません。たとえば、FixedPage パート内の無効なマークアップは検出されません。

XPS パッケージをストリームからデジタル署名マネージャーに読み込みます。

このメソッドは HRESULT を返します。指定できる値には次の表の値が含まれますが、これらに限定されません。この表に記載されていない戻り値については、XPS Digital Signature API Errors および XPS Document Errors を参照してください。

インターフェイスをインスタンス化した後、このインターフェイスの他のメソッドを呼び出す前に、このメソッドまたは LoadPackageFile を呼び出して XPS パッケージを読み込む必要があります。

IXpsSignatureManager のインスタンスに XPS パッケージを読み込んだ後、同じインスタンスで LoadPackageFile または LoadPackageStream を呼び出すと、エラーが返されます。

LoadPackageFile または LoadPackageStream を呼び出した後、同じオブジェクトを別の XPS パッケージ ファイルやストリームに再利用することはできません。別の XPS パッケージを読み込むには、IXpsSignatureManager の新しいインスタンスをインスタンス化する必要があります。

LoadPackageStream は、XPS パッケージのすべての内容を検証するわけではありません。たとえば、FixedPage パート内の無効なマークアップは検出されません。

stream に渡す IStream インターフェイスの実装は、ランダムな読み取りアクセスをサポートしている必要があります。また、この実装には XPS パッケージのみが格納されており、このメソッドで使用する前にストリームの先頭に位置付けられている必要があります。

署名オプションで指定された内容に従って XPS パッケージの内容に署名し、生成されたデジタル署名を返します。

このメソッドは HRESULT を返します。指定できる値には次の表の値が含まれますが、これらに限定されません。この表に記載されていない戻り値については、XPS Digital Signature API Errors および XPS Document Errors を参照してください。

新しい署名を追加しても、LoadPackageFile メソッドまたは LoadPackageStream メソッドの呼び出しで読み取った元のファイルやストリームは上書きされません。 署名は、パッケージが保存される (SavePackageToFile メソッドまたは SavePackageToStream メソッドが呼び出される) まで、XPS パッケージのメモリ内コピーに追加されます。

新しい署名にマークアップ互換性要素を含むパートが含まれる場合、既定ではこのメソッドは XPS_E_MARKUP_COMPATIBILITY_ELEMENTS エラーで失敗します。 この動作を変更するには IXpsSigningOptions::SetFlags を呼び出します。これにより、signOptions パラメーターで参照される IXpsSigningOptions インターフェイスに XPS_SIGN_FLAGS_IGNORE_MARKUP_COMPATIBILITY フラグが設定されます。

このメソッドが戻り値の一覧にない HRESULT 値を返した場合は、署名マネージャーを解放して作成し直す必要があります。

このメソッドは、新しい署名によって既存の署名が無効になる場合でも成功します。

署名オリジン パートのパート名を取得します。

このメソッドは HRESULT を返します。指定できる値には次の表の値が含まれますが、これらに限定されません。この表に記載されていない戻り値については、XPS Digital Signature API Errors および XPS Document Errors を参照してください。

署名オリジン パートのパート名を設定します。

メソッドが成功した場合は S_OK を返します。それ以外の場合は、次の表に示す HRESULT エラー コード、または IOpcDigitalSignatureManager::SetSignatureOriginPartName が返す HRESULT エラー コードを返します。

署名が 1 つでも存在する場合、パート名は設定できません。

XPS デジタル署名のコレクションを格納する IXpsSignatureCollection インターフェイスへのポインターを取得します。

このメソッドは HRESULT を返します。指定できる値には次の表の値が含まれますが、これらに限定されません。この表に記載されていない戻り値については、XPS Digital Signature API Errors および XPS Document Errors を参照してください。

signatures に返される署名コレクションには、XML Paper Specification に準拠していないデジタル署名が含まれる場合があります。

新しい IXpsSignatureBlock インターフェイスを作成し、署名ブロック コレクションに追加します。

このメソッドは HRESULT を返します。指定できる値には次の表の値が含まれますが、これらに限定されません。この表に記載されていない戻り値については、XPS Digital Signature API Errors および XPS Document Errors を参照してください。

署名ブロックは、XPS パッケージ内の SignatureDefinitions パートを表します。XML Paper Specification のセクション 10.2.2 によると、各 FixedDocument には 0 個以上の SignatureDefinitions パートを関連付けることができます。 このメソッドは、指定された名前で新しい SignatureDefinitions パートを作成し、指定された FixedDocument パートからリレーションシップでリンクし、 新しい IXpsSignatureBlock インターフェイスを作成して、この新しいインターフェイスを内部の署名ブロック コレクションに追加します。

署名ブロックを取得するには、GetSignatureBlocks メソッドを呼び出します。

署名ブロックのコレクションを格納する IXpsSignatureBlockCollection インターフェイスへのポインターを取得します。

このメソッドは HRESULT を返します。指定できる値には次の表の値が含まれますが、これらに限定されません。この表に記載されていない戻り値については、XPS Digital Signature API Errors および XPS Document Errors を参照してください。

新しい IXpsSigningOptions インターフェイスを作成します。

このメソッドは HRESULT を返します。指定できる値には次の表の値が含まれますが、これらに限定されません。この表に記載されていない戻り値については、XPS Digital Signature API Errors および XPS Document Errors を参照してください。

新しい IXpsSigningOptions インターフェイスは、Sign メソッドの署名オプションを設定するために使用できます。ただし、この新しいインターフェイスを Sign メソッドのパラメーターとして使用する前に、SignatureMethod プロパティと DigestMethod プロパティを初期化しておく必要があります。

このメソッドで作成した IXpsSigningOptions インターフェイスは、複数回の Sign メソッド呼び出しで使用できます。

XPS パッケージをファイルに保存します。

このメソッドは HRESULT を返します。指定できる値には次の表の値が含まれますが、これらに限定されません。この表に記載されていない戻り値については、XPS Digital Signature API Errors および XPS Document Errors を参照してください。

このメソッドが、このメソッドの戻り値の一覧にない HRESULT 値を返した場合は、署名マネージャーを解放して作成し直す必要があります。

XPS パッケージをストリームに書き込んで保存します。

このメソッドは HRESULT を返します。指定できる値には次の表の値が含まれますが、これらに限定されません。この表に記載されていない戻り値については、XPS Digital Signature API Errors および XPS Document Errors を参照してください。

このメソッドが、このメソッドの戻り値の一覧にない HRESULT 値を返した場合は、署名マネージャーを解放して作成し直す必要があります。