RetrieveImageResponse 元素

项目
02/12/2024

所需的 RetrieveImageResponse 操作元素将扫描数据返回给客户端。

使用情况

<wscn:RetrieveImageResponse>
  child elements
</wscn:RetrieveImageResponse>

属性

没有属性。

子元素

元素
ScanData

父元素

没有父元素。

注解

WSD 扫描服务必须支持 RetrieveImageResponse 操作元素。当客户端成功发送 RetrieveImageRequest 元素时，扫描服务会发送此元素。

扫描服务使用 RetrieveImageResponse 数据包以二进制附件的形式返回扫描数据。响应必须打包为 MIME Multipart-Related 内容类型，并使用 SOAP 消息传输优化机制 [MTOM] 有效地发送二进制图像数据。

扫描服务在结果文件中返回的图像数取决于 ScanTicket 的 ImagesToTransfer 元素和图像文件 Format 元素的组合，如下所示：

如果 Format 指定单个图像格式，则返回的文件将始终包含单个图像。
如果 Format 指定多页格式，则返回的文件将包含输入源最多可以扫描到 ImagesToTransfer 值的图像数。

如果 Format 指定单个图像格式，并且 ImagesToTransfer 的值为 0 或大于 1，则客户端将发送重复 的 RetrieveImageRequest 操作元素，直到扫描服务使用 ClientErrorNoImagesAvailable 错误进行答复，或直到满足 ImagesToTransfer 值为止。

如果在传输图像数据的过程中出现通信错误，扫描服务应使用 ImageTransferError 的 JobStateReason 中止作业。

示例

下面的代码示例演示 WSD 扫描服务如何将图像数据发送到客户端。

mime-version: 1.0
Content-Type: multipart/related;
    type=application/xop+xml;
    boundary=4aa7d814-adc1-47a2-8e1c-07585b9892a4;
    start="<14629f74-2047-436c-8046-5cac76d280fc@uuid>";
    startinfo=application/soap+xml


--4aa7d814-adc1-47a2-8e1c-07585b9892a4
Content-Type: application/xop+xml; type="application/soap+xml"
                                   charset=UTF-8
Content-Transfer-Encoding: binary
Content-ID: <14629f74-2047-436c-8046-5cac76d280fc@uuid>

<?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:xop="https://www.w3.org/2003/12/xop/include"
  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>https://schemas.xmlsoap.org/ws/2003/03/addressing/role/anonymous</wsa:To>
    <wsa:Action>
      https://schemas.microsoft.com/windows/2006/01/wdp/scan/RetrieveImage
    </wsa:Action>
    <wsa:MessageID>uuid:UniqueMsgId</wsa:MessageID>
    <wsa:RelatesTo>uuid:MsgIdOfTheRetrieveImageRequest</wsa:RelatesTo>
  </soap:Header>

  <soap:Body>
    <wscn:RetrieveImageResponse>
      <wscn:ScanData>
        <xop:Include href="cid:1c696bd7-005a-48d9-9ee9-9adca11f8892@uuid" />
      </wscn:ScanData>
    </wscn:RetrieveImageResponse>
  </soap:Body>
</soap:Envelope>

--4aa7d814-adc1-47a2-8e1c-07585b9892a4

Content-Type: image/jpeg;
Content-Transfer-Encoding: binary
Content-ID: <1c696bd7-005a-48d9-9ee9-9adca11f8892@uuid >

Binary Scan Data
--4aa7d814-adc1-47a2-8e1c-07585b9892a4--