共用方式為

CreateScanJobRequest 元素

  • 發行項

必要的 CreateScanJobRequest 作業會準備掃描裝置進行掃描。

使用方式

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

屬性

沒有屬性。

文字值

None

子元素

元素
DestinationToken
ScanIdentifier
ScanTicket

父元素

沒有父元素。

備註

WSD 掃描服務必須支援 CreateScanJobRequest 作業。

CreateScanJobRequest 作業是準備掃描裝置以掃描可用映像的主要機制。 這項作業可以在兩個不同的方法中起始。 每個方法都會將不同的自變數傳送至 CreateScanJobRequest。 這兩種方法和自變數如下：

  • 用戶選取目的地，並在裝置上推送掃描按鈕。 在此方法中，用戶端會傳送 具有下列子元素的 CreateScanJobRequest ：

    • Scan Service 透過 ScanAvailableEvent 傳回用戶端的 ScanIdentifier 元素。 掃描服務應該檢查此標識碼，以確保在用戶選取目的地之後，正確的用戶端要求掃描。

    • WSD 掃描服務訂閱接收 ScanAvailableEvent 事件時，會傳回給用戶端的 DestinationToken 元素。 掃描服務應該藉由檢查此令牌來檢查正確的用戶端是否要求掃描。

    • ScanTicket 元素，可控制掃描的處理。 掃描票證中的值是使用者前往裝置起始掃描之前，在用戶端設定的預設值。

  • 使用者會在用戶端上啟動應用程式，並取得映像。 在此方法中，用戶端只會傳送具有 ScanTicket 元素的 CreateScanJobRequest。

CreateScanJobRequest 階層內的某些元素可以包含 MustHonor Boolean 屬性。 如果 MustHonor 存在且為 true，WSD 掃描服務必須接受要求的專案及其值，或拒絕掃描作業要求。 如果不支援的項目沒有 MustHonor 屬性，或其 MustHonor 屬性為 false，則 WSD 掃描服務必須忽略它。 如果支援的元素 MustHonor 屬性為 false，則 WSD 掃描服務必須將所要求的值取代為支援的值。

如果客戶端在掃描作業要求中提供元素的衝突組合（例如 InputSource 和 Resolution），如果衝突的專案具有 True 的 MustHonor 屬性值，WSD 掃描服務必須拒絕掃描作業要求。

下列元素可以具有 MustHonor 属性：ColorProcessing、CompressionQualityFactor、ContentType、Exposure、FilmScanMode、ImagesToTransfer、InputSize、InputSource、MediaSides、Resolution、Rotation、縮放、ScanRegionHeight、ScanRegionWidth、ScanRegionXOffset 和 ScanRegionYOffset。

這項作業可以傳回所有 常見的 WSD 掃描服務作業錯誤碼。 如需如何報告錯誤的詳細資訊，請參閱 WSD 掃描服務作業錯誤報告。

CreateScanJobRequest 也可以傳回下列錯誤：

  • ServerErrorNotAcceptingJobs 伺服器無法接受新的掃描作業。 此錯誤可能是因為掃描器已進入服務模式，或是因為有使用者介入狀況，而且所有記憶體緩衝區都已用盡。 用戶端可以在稍後的某個時間點再次嘗試未修改的要求，並預期伺服器已解除封鎖，而且掃描器會再次接受作業。

    Fault 屬性 定義
    [程序代碼] soap：Receiver
    [子程序代碼] wscn：ServerErrorNotAcceptingJobs
    [原因] 服務暫時遭到封鎖，且無法接受新的作業或檔要求。
    [詳細數據] 無

  • ClientErrorFormatNotSupported 掃描器不支援提供的 Format 值。

    Fault 屬性 定義
    [程序代碼] soap：Sender
    [子程序代碼] wscn：ClientErrorFormatNotSupported
    [原因] 不支援 [檔案格式] 參數值。
    [詳細數據] 選擇性。 掃描服務可以傳回支援的格式清單。 這個項目中的數據應該是 wscn：FormatSupportedType 類型<>。

  • ClientErrorInvalidScanIdentifier 提供的 ScanIdentifier 值目前在掃描裝置內無效。

    Fault 屬性 定義
    [程序代碼] soap：Sender
    [子程序代碼] wscn：ClientErrorInvalidScanIdentifier
    [原因] ScanIdentifier 參數值目前無效。
    [詳細數據] 無

  • ClientErrorInvalidDestinationToken 提供的 DestinationToken 值對掃描裝置無效。

    Fault 屬性 定義
    [程序代碼] soap：Sender
    [子程序代碼] wscn：ClientErrorInvalidDestinationToken
    [原因] DestinationToken 參數值目前無效。
    [詳細數據] 無

  • ClientErrorNoImagesAvailable 伺服器無法接受新的掃描作業，因為沒有媒體需要掃描。 例如，當掃描作業從附加至掃描器的自動檔摘要器執行時，就會產生此錯誤，而摘要器是空的。 用戶端稍後可以再次嘗試未修改的要求，並預期已修正條件，而且掃描器現在有媒體需要掃描。

    Fault 屬性 定義
    [程序代碼] 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