次の方法で共有

CreateScanJobRequest 要素

  • [アーティクル]

必須の CreateScanJobRequest 操作により、スキャン デバイスがスキャン用に準備されます。

使用方法

<wscn:CreateScanJobRequest>
  child elements
</wscn:CreateScanJobRequest>

属性

属性はありません。

Text 値

なし

子要素

要素
DestinationToken
ScanIdentifier
ScanTicket

親要素

親要素は存在しません。

解説

WSD スキャン サービスは、CreateScanJobRequest 操作に対応している必要があります。

CreateScanJobRequest 操作は、使用可能なイメージをスキャンするスキャン デバイスを準備するためのメイン メカニズムです。 この操作は、2 つの異なるメソッドで開始できます。 各メソッドは、CreateScanJobRequest に異なる引数を送信します。 2 つのメソッドと引数は次のとおりです。

  • ユーザーが宛先を選択し、デバイスでスキャン ボタンを押します。 このメソッドでは、クライアントが次の子要素を含む CreateScanJobRequest を送信します。

    • ScanAvailableEvent を通じてスキャン サービスがクライアントに返す ScanIdentifier 要素。 スキャン サービスは、この識別子をチェックし、ユーザーが宛先を選択した後に正しいクライアントがスキャンを要求していることを確認する必要があります。

    • ScanAvailableEvent イベントの受信をサブスクライブしたときに WSD スキャン サービスがクライアントに返す DestinationToken 要素。 スキャン サービスは、正しいクライアントがこのトークンをチェックしてスキャンを要求していることをチェックする必要があります。

    • スキャンの処理を制御する ScanTicket 要素。 スキャン チケットの値は、ユーザーがスキャン開始のためにデバイスに移動する前にクライアントで設定される既定値です。

  • ユーザーがクライアントでアプリケーションを起動し、イメージを取得します。 このメソッドでは、クライアントが ScanTicket 要素のみを使用して CreateScanJobRequest を送信します。

CreateScanJobRequest 階層内の特定の要素には、MustHonor ブール属性を含めることができます。 MustHonor が存在していて、true の場合、WSD スキャン サービスは、要求された要素とその値を優先するか、スキャン ジョブ要求を拒否する必要があります。 サポートされていない要素に MustHonor 属性がない場合、またはその MustHonor 属性が false の場合、WSD スキャン サービスはそれを無視する必要があります。 サポートされている要素の MustHonor 属性が false の場合、WSD スキャン サービスは、サポートされている値を使って、要求された値を構成する必要があります。

スキャン ジョブ要求内の要素の競合する組み合わせがクライアントにより提供される場合 (InputSource や Resolution など)、競合する要素の MustHonor 属性値が true の場合、WSD スキャン サービスはスキャン ジョブ要求を拒否する必要があります。

ColorProcessing、CompressionQualityFactor、ContentType、Exposure、FilmScanMode、ImagesToTransfer、InputSize、InputSource、MediaSides、Resolution、Rotation、Scaling、ScanRegionHeight、ScanRegionWidth、ScanRegionXOffset、ScanRegionYOffset の各要素が MustHonor 属性を持つことができます。

この操作は、すべての一般的な WSD スキャン サービス操作エラー コードを返します。 エラーを報告する方法の詳細は、「WSD スキャン サービス操作エラー報告」を参照してください。

CreateScanJobRequest は、次のエラーを返すこともできます。

  • ServerErrorNotAcceptingJobs サーバーは新しいスキャン ジョブを受け入れることができません。 このエラーは、スキャナーがサービス モードになった場合、またはユーザーの介入条件を満たして、すべてのメモリ バッファーが使い果たされた場合に発生する可能性があります。 クライアントは、サーバーがブロック解除されて、スキャナーが再びジョブを受け入れることを期待し、後の時点で変更されていない要求をもう一度試すことができます。

    Fault プロパティ Definition
    [コード] soap:Receiver
    [サブコード] wscn:ServerErrorNotAcceptingJobs
    [理由] サービスは一時的にブロックされ、新しいジョブまたはドキュメント要求を受け入れることができません。
    [詳細] なし

  • ClientErrorFormatNotSupported スキャナーは、指定された Format 値をサポートしていません。

    Fault プロパティ Definition
    [コード] soap:Sender
    [サブコード] wscn:ClientErrorFormatNotSupported
    [理由] Document Format パラメーターの値はサポートされていません。
    [詳細] 省略可能。 スキャン サービスは、サポートされている形式の一覧を返すことができます。 この要素のデータは、<wscn:FormatSupportedType> 型でなければなりません。

  • ClientErrorInvalidScanIdentifier 指定された ScanIdentifier 値が、スキャン デバイス内で現在有効ではありません。

    Fault プロパティ Definition
    [コード] soap:Sender
    [サブコード] wscn:ClientErrorInvalidScanIdentifier
    [理由] ScanIdentifier パラメーターの値は現在無効です。
    [詳細] なし

  • ClientErrorInvalidDestinationToken 指定された DestinationToken 値がスキャン デバイスに対して有効ではありません。

    Fault プロパティ Definition
    [コード] soap:Sender
    [サブコード] wscn:ClientErrorInvalidDestinationToken
    [理由] DestinationToken パラメーターの値は現在無効です。
    [詳細] なし

  • ClientErrorNoImagesAvailable スキャンするメディアがないため、サーバーは新しいスキャン ジョブを受け入れられません。 たとえば、このエラーは、スキャナーに接続されている自動ドキュメント フィーダーからスキャン ジョブが実行され、フィーダーが空のときに生成されます。 クライアントは、条件が修正され、スキャン対象のメディアがスキャナーに挿入されることを期待して、変更されていない要求を後でもう一度試すことができます。

    Fault プロパティ Definition
    [コード] soap:Sender
    [サブコード] wscn:ClientErrorNoImagesAvailable
    [理由] サーバーには、取得できるイメージがありません。
    [詳細] なし

例

次のコード例は、スキャン デバイスからスキャンが開始されたときのスキャン ジョブ要求を示しています。

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope
  xmlns:soap="https://www.w3.org/2003/05/soap-envelope"
  xmlns:wsa="https://schemas.xmlsoap.org/ws/2003/03/addressing"
  xmlns:wscn="https://schemas.microsoft.com/windows/2006/01/wdp/scan"
  soap:encodingStyle='https://www.w3.org/2002/12/soap-encoding' >

  <soap:Header>
    <wsa:To>AddressofScannerService</wsa:To>
    <wsa:Action>
      https://schemas.microsoft.com/windows/2006/01/wdp/scan/CreateScanJob
    </wsa:Action>
    <wsa:MessageID>uuid:UniqueMsgId</wsa:MessageID>
  </soap:Header>

  <soap:Body>
    <wscn:CreateScanJobRequest>
      <wscn:ScanIdentifier>
        uuid:12e7a983-1034-5428-d298-0016f11097fa
      </wscn:ScanIdentifier>
      <wscn:DestinationToken>
        Dest1234TokenString
      </wscn:DestinationToken>
      <wscn:ScanTicket>
        <wscn:JobDescription>
          <wscn:JobName>Photo Scan</wscn:JobName>
          <wscn:JobOriginatingUserName>RogerSmith</JobOriginatingUserName>
        </wscn:JobDescription>
        <wscn:DocumentParameters>
          <wscn:Format>jfif</wscn:Format>
          <wscn:CompressionQualityFactor>45</wscn:CompressionQualityFactor>
          <wscn:InputSource>Platen</wscn:InputSource>
          <wscn:ContentType>Auto</wscn:ContentType>
          <wscn:InputSize>
            <wscn:DocumentSizeAutoDetect>true</wscn:DocumentSizeAutoDetect>
          </wscn:InputSize>
          <wscn:Scaling wscn:MustHonor="1">
            <wscn:ScalingWidth>125</wscn:ScalingWidth>
            <wscn:ScalingHeight>125</wscn:ScalingHeight>
          </wscn:Scaling>
          <wscn:MediaSides>
            <wscn:MediaFront>
              <wscn:Resolution wscn:MustHonor="1">
                <wscn:Width>300</wscn:Width>
                <wscn:Height>300</wscn:Height>
              </wscn:Resolution>
            </wscn:MediaFront>
          </wscn:MediaSides>
        </wscn:DocumentParameters>
      </wscn:ScanTicket>
    </wscn:CreateScanJobRequest>
  </soap:Body>
</soap:Envelope>

次のコード例は、クライアント上のアプリケーションからスキャンが開始されたときのスキャン ジョブ要求を示しています。

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope
  xmlns:soap="https://www.w3.org/2003/05/soap-envelope"
  xmlns:wsa="https://schemas.xmlsoap.org/ws/2003/03/addressing"
  xmlns:wscn="https://schemas.microsoft.com/windows/2006/01/wdp/scan"
  soap:encodingStyle='https://www.w3.org/2002/12/soap-encoding' >

  <soap:Header>
    <wsa:To>AddressofScannerService</wsa:To>
    <wsa:Action>
      https://schemas.microsoft.com/windows/2006/01/wdp/scan/CreateScanJob
    </wsa:Action>
    <wsa:MessageID>uuid:UniqueMsgId</wsa:MessageID>
  </soap:Header>

  <soap:Body>
    <wscn:CreateScanJobRequest>
      <wscn:ScanTicket>
        <wscn:JobDescription>
          <wscn:JobName>Application Scan</wscn:JobName>
          <wscn:JobOriginatingUserName>RogerSmith</JobOriginatingUserName>
        </wscn:JobDescription>
        <wscn:DocumentParameters>
          <wscn:Format>xps</wscn:Format>
          <wscn:ImagesToTransfer>0</wscn:ImagesToTransfer>
          <wscn:InputSource>ADF</wscn:InputSource>
          <wscn:ContentType>Auto</wscn:ContentType>
          <wscn:InputSize>
            <wscn:DocumentSizeAutoDetect>true</wscn:DocumentSizeAutoDetect>
          </wscn:InputSize>
          <wscn:MediaSides>
            <wscn:MediaFront>
              <wscn:ColorProcessing>RGB48</wscn:ColorProcessing>
              <wscn:Resolution>
                <wscn:Width>1200</wscn:Width>
              </wscn:Resolution>
            </wscn:MediaFront>
          </wscn:MediaSides>
        </wscn:DocumentParameters>
        <wscn:DocumentDescription>
          <wscn:DocumentName>Scan001.jpg</DocumentName>
        </wscn:DocumentDescription>
      </wscn:ScanTicket>
    </wscn:CreateScanJobRequest>
  </soap:Body>
</soap:Envelope>

関連項目

ColorProcessing

CompressionQualityFactor

ContentType

CreateScanJobResponse

DestinationToken

露出

FilmScanMode

ImagesToTransfer

InputSize

InputSource

MediaSides

解像度

回転

スケーリング

ScanAvailableEvent

ScanIdentifier

ScanRegionHeight

ScanRegionWidth

ScanRegionXOffset

ScanRegionYOffset

ScanTicket