Элемент CreateScanJobRequest

Статья
07/16/2024

Требуемая операция CreateScanJobRequest подготавливает устройство сканирования для сканирования.

Использование

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

Атрибуты

Атрибуты отсутствуют.

Текстовое значение

нет

Дочерние элементы

Элемент
DestinationToken
ScanIdentifier
ScanTicket

Родительские элементы

Родительские элементы отсутствуют.

Замечания

Служба проверки WSD должна поддерживать операцию CreateScanJobRequest .

Операция CreateScanJobRequest — это основной механизм подготовки устройства сканирования для сканирования изображений, доступных для него. Эта операция может быть инициирована двумя разными методами. Каждый метод отправляет разные аргументы в CreateScanJobRequest. Два метода и аргументы:

Пользователь выбирает место назначения и нажимает кнопку сканирования на устройстве. В этом методе клиент отправляет CreateScanJobRequest со следующими дочерними элементами:
- Элемент ScanIdentifier, возвращаемый службой Scan Service, через ScanAvailableEvent. Служба сканирования должна проверить этот идентификатор, чтобы убедиться, что правильный клиент запрашивает проверку после того, как пользователь выбрал место назначения.
- Элемент DestinationToken, возвращаемый службой WSD Scan Service, когда он подписан на получение событий ScanAvailableEvent. Служба сканирования должна проверить, что правильный клиент запрашивает проверку, проверив этот маркер.
- Элемент ScanTicket для управления обработкой сканирования. Значения в билете сканирования — это значения по умолчанию, заданные на клиенте до того, как пользователь пошел на устройство, чтобы инициировать проверку.
Пользователь запускает приложение на клиенте и получает изображение. В этом методе клиент отправляет CreateScanJobRequest только с элементом ScanTicket .

Некоторые элементы в иерархии CreateScanJobRequest могут содержать логический атрибут MustHonor . Если mustHonor присутствует и true, служба проверки WSD должна учитывать запрошенный элемент и его значение или отклонять запрос задания сканирования. Если неподдерживаемый элемент не имеет атрибута MustHonor или если его атрибут MustHonor имеет значение false, служба WSD Scan должна игнорировать ее. Если атрибут MustHonor поддерживаемого элемента имеет значение false, служба проверки WSD должна заменить запрошенное значение поддерживаемым.

Если клиент предоставляет конфликтующее сочетание элементов в запросе задания сканирования (например, InputSource и Resolution), служба проверки WSD должна отклонить запрос задания сканирования, если конфликтующие элементы имеют значение атрибута MustHonor true.

Следующие элементы могут иметь атрибут MustHonor: ColorProcessing, CompressionQualityFactor, ContentType, Exposure, FilmScanMode, ImagesToTransfer, InputSize, InputSource, MediaSides, Resolution, Rotation , Scaling, ScanRegionHeight, ScanRegionWidth, ScanRegionXOffset и ScanRegionYOffset.

Эта операция может возвращать все распространенные коды ошибок службы сканирования WSD. Дополнительные сведения о том, как сообщать об ошибках, см. в статье WSD Scan Service Operation Error Reporting.

CreateScanJobRequest также может возвращать следующие ошибки:

ServerErrorNotAcceptingJobs Сервер не может принять новое задание сканирования. Эта ошибка может возникнуть из-за того, что сканер был помещен в режим обслуживания или из-за того, что существует условие вмешательства пользователя, и все буферы памяти были исчерпаны. Клиент может снова попробовать неизмененные запросы в какой-то момент времени с ожиданием того, что сервер был разблокирован, и сканер снова принимает задания.

Свойство сбоя	Определение
[Код]	soap:Receiver
[Вложенный код]	wscn:ServerErrorNotAcceptingJobs
[Причина]	Служба временно заблокирована и не может принимать новые запросы на задание или документ.
[Подробные сведения]	нет

ClientErrorFormatNotSupported Сканер не поддерживает указанное значение формата.

Свойство сбоя	Определение
[Код]	soap:Sender
[Вложенный код]	wscn:ClientErrorFormatNotSupported
[Причина]	Значение параметра формата документа не поддерживается.
[Подробные сведения]	Необязательно. Служба сканирования может возвращать список поддерживаемых форматов. Данные в этом элементе должны иметь тип <wscn:FormatSupportedType>.

ClientErrorInvalidScanIdentifier Указанное значение ScanIdentifier в настоящее время недопустимо на устройстве сканирования.

Свойство сбоя	Определение
[Код]	soap:Sender
[Вложенный код]	wscn:ClientErrorInvalidScanIdentifier
[Причина]	Значение параметра ScanIdentifier в настоящее время недопустимо.
[Подробные сведения]	нет

ClientErrorInvalidDestinationToken Указанное значение DestinationToken недопустимо для устройства сканирования.

Свойство сбоя	Определение
[Код]	soap:Sender
[Вложенный код]	wscn:ClientErrorInvalidDestinationToken
[Причина]	Значение параметра DestinationToken в настоящее время недопустимо.
[Подробные сведения]	нет

ClientErrorNoImagesAvailable Сервер не может принять новое задание сканирования, так как нет носителя для сканирования. Например, эта ошибка возникает при выполнении задания сканирования из автоматического веб-канала документов, подключенного к сканеру, и веб-канал пуст. Клиент может снова попробовать неизмененные запросы позже, ожидая, что условие было исправлено, и сканер теперь имеет носитель для сканирования.

Свойство сбоя	Определение
[Код]	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>