RetrieveImageRequest 元素
所需的 RetrieveImageRequest 操作元素包含客户端在创建扫描作业后从设备检索扫描数据的请求。
使用情况
<wscn:RetrieveImageRequest>
child elements
</wscn:RetrieveImageRequest>
属性
没有属性。
子元素
| 元素 |
|---|
| DocumentDescription |
| JobId |
| JobToken |
父元素
没有父元素。
注解
WSD 扫描服务必须支持 RetrieveImageRequest 操作元素。
扫描服务必须验证客户端提供的 JobId 和 JobToken 元素，以确保作业有效并且是由请求检索的客户端创建的。 如果请求有效，扫描服务必须使用 RetrieveImageResponse 操作元素进行响应。
此操作可以返回所有 常见的 WSD 扫描服务操作错误代码。 有关如何报告错误的详细信息，请参阅 WSD 扫描服务操作错误报告。
此操作还可能返回以下错误：
ClientErrorJobIdNotFound扫描程序找不到与 JobId 值匹配的作业，或者 JobId 值不在定义的范围内。
Fault 属性 定义 [代码] soap：Sender [子代码] wscn：ClientErrorJobIdNotFound [原因] 找不到指定的 JobId。 [详细信息] JobId：错误的 JobId ClientErrorNoImagesAvailable扫描程序没有可供客户端检索的更多图像。
Fault 属性 定义 [代码] soap：Sender [子代码] wscn：ClientErrorNoImagesAvailable [原因] 服务器没有可供获取的映像。 [详细信息] 无 ClientErrorInvalidJobToken提供的 JobToken 值对于指定的扫描 JobId 无效。
Fault 属性 定义 [代码] soap：Sender [子代码] wscn：ClientErrorInvalidJobToken [原因] JobToken 参数值在 JobId 参数中无效。 [详细信息] 无 ClientErrorJobCancelled
Fault 属性 定义 [代码] soap：Sender [子代码] wscn：ClientErrorJobCancelled [原因] 当前扫描作业已取消。 [详细信息] 无
示例
下面的代码示例演示了一个客户端请求，用于检索 JobId 1 标识的作业的图像数据。
<?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/RetrieveImage
</wsa:Action>
<wsa:MessageID>uuid:UniqueMsgId</wsa:MessageID>
</soap:Header>
<soap:Body>
<wscn:RetrieveImageRequest>
<wscn:JobId>1</wscn:JobId>
<wscn:JobToken>Job9876TokenString</wscn:JobToken>
<wscn:DocumentDescription>
<wscn:DocumentName>Scan001.jpg</DocumentName>
</wscn:DocumentDescription>
</wscn:RetrieveImageRequest>
</soap:Body>
</soap:Envelope>