CreateScanJobRequest-Element
Der erforderliche CreateScanJobRequest-Vorgang bereitet ein Scangerät zum Scannen vor.
Verbrauch
<wscn:CreateScanJobRequest>
child elements
</wscn:CreateScanJobRequest>
Attribute
Es gibt keine Attribute.
Text Wert
Keine
Untergeordnete Elemente
| Element |
|---|
| DestinationToken |
| ScanIdentifier |
| ScanTicket |
Übergeordnete Elemente
Es gibt sich keine übergeordneten Elemente.
Hinweise
Der WSD-Scandienst muss den CreateScanJobRequest-Vorgang unterstützen.
Der CreateScanJobRequest-Vorgang ist der Hauptmechanismus zum Vorbereiten eines Scangeräts zum Scannen der Bilder, die ihm zur Verfügung stehen. Dieser Vorgang kann in zwei verschiedenen Methoden initiiert werden. Jede Methode sendet unterschiedliche Argumente an CreateScanJobRequest. Die beiden Methoden und Argumente sind:
Der Benutzer wählt ein Ziel aus und drückt die Scantaste auf dem Gerät. Bei dieser Methode sendet der Client eine CreateScanJobRequest mit den folgenden untergeordneten Elementen:
Das ScanIdentifier-Element, das der Scandienst über ScanAvailableEvent an den Client zurückgibt. Der Scandienst sollte diesen Bezeichner überprüfen, um sicherzustellen, dass der richtige Client den Scan anfordert, nachdem der Benutzer das Ziel ausgewählt hat.
Das DestinationToken-Element, das der WSD-Scandienst an den Client zurückgibt, wenn er ScanAvailableEvent-Ereignisse abonniert hat. Der Scandienst sollte durch Überprüfen dieses Tokens überprüfen, ob der richtige Client den Scan anfordert.
Ein ScanTicket-Element zur Steuerung der Verarbeitung des Scans. Die Werte im Scanticket sind die Standardwerte, die auf dem Client festgelegt werden, bevor der Benutzer das Gerät verwendet, um den Scan zu initiieren.
Der Benutzer startet eine Anwendung auf dem Client und erhält ein Bild. Bei dieser Methode sendet der Client CreateScanJobRequest nur mit dem ScanTicket-Element .
Bestimmte Elemente innerhalb der CreateScanJobRequest-Hierarchie können das Boolean-Attribut MustHonor enthalten. Wenn MustHonor vorhanden und true ist, muss der WSD-Scandienst das angeforderte Element und seinen Wert berücksichtigen oder die Scanauftragsanforderung ablehnen. Wenn ein nicht unterstütztes Element nicht über ein MustHonor-Attribut verfügt oder sein MustHonor-Attribut false ist, muss der WSD-Scandienst es ignorieren. Wenn das MustHonor-Attribut eines unterstützten Elements false ist, muss der WSD-Scandienst den angeforderten Wert durch einen unterstützten ersetzen.
Wenn der Client eine widersprüchliche Kombination von Elementen in der Scanauftragsanfrage liefert (wie InputSource und Resolution), muss der WSD-Scandienst die Scanauftragsanforderung zurückweisen, wenn die widersprüchlichen Elemente ein MustHonour-Attribut von true aufweisen.
Die folgenden Elemente können über das MustHonor-Attribut verfügen: ColorProcessing, CompressionQualityFactor, ContentType, Exposure, FilmScanMode, ImagesToTransfer, InputSize, InputSource, MediaSides, Resolution, Rotation, Scaling, ScanRegionHeight, ScanRegionWidth, ScanRegionXOffset, and ScanRegionYOffset.
Dieser Vorgang kann alle allgemeinen Fehlercodes des WSD-Scandiensts zurückgeben. Weitere Informationen zum Melden von Fehlern finden Sie unter WSD Scan Service Operation Error Reporting.
CreateScanJobRequest kann auch die folgenden Fehler zurückgeben:
ServerErrorNotAcceptingJobs Der Server kann keinen neuen Scanauftrag annehmen. Dieser Fehler kann auftreten, weil der Scanner in den Wartungsmodus versetzt wurde oder weil es eine Benutzereingriffsbedingung gibt und alle Speicherpuffer erschöpft wurden. Der Client kann die nicht geänderte Anforderung zu einem späteren Zeitpunkt erneut versuchen, wobei erwartet wird, dass der Server entsperrt wurde und der Scanner Aufträge erneut akzeptiert.
Fehlereigenschaft Definition [Code] soap:Receiver [Subcode] wscn:ServerErrorNotAcceptingJobs [Grund] Der Dienst ist vorübergehend blockiert und kann keine neuen Auftrags- oder Dokumentanforderungen annehmen. [Detail] Keine ClientErrorFormatNotSupported Der Scanner unterstützt nicht den angegebenen Formatwert.
Fehlereigenschaft Definition [Code] soap:Sender [Subcode] wscn:ClientErrorFormatNotSupported [Grund] Der Parameterwert „Document Format“ wird nicht unterstützt. [Detail] Optional. Der Scandienst kann eine Liste der unterstützten Formate zurückgeben. Die Daten in diesem Element sollten vom Typ <wscn:FormatSupportedType> sein. ClientErrorInvalidScanIdentifier Der angegebene ScanIdentifier-Wert ist derzeit nicht innerhalb des Scangeräts gültig.
Fehlereigenschaft Definition [Code] soap:Sender [Subcode] wscn:ClientErrorInvalidScanIdentifier [Grund] Der Parameterwert ScanIdentifier ist zurzeit ungültig. [Detail] Keine ClientErrorInvalidDestinationToken Der angegebene DestinationToken-Wert ist für das Scangerät ungültig.
Fehlereigenschaft Definition [Code] soap:Sender [Subcode] wscn:ClientErrorInvalidDestinationToken [Grund] Der Parameterwert DestinationToken ist zurzeit ungültig. [Detail] Keine ClientErrorNoImagesAvailable Der Server kann keinen neuen Scanauftrag akzeptieren, da keine Medien zum Scannen verfügbar sind. Dieser Fehler wird beispielsweise generiert, wenn ein Scanauftrag vom automatischen Dokumenteinzug ausgeführt wird, der an den Scanner angefügt ist, und der Einzug leer ist. Der Client kann die nicht geänderte Anforderung später erneut ausprobieren, wobei erwartet wird, dass die Bedingung aufgehoben wurde und der Scanner jetzt Medien zum Scannen hat.
Fehlereigenschaft Definition [Code] soap:Sender [Subcode] wscn:ClientErrorNoImagesAvailable [Grund] Der Server verfügt über keine Bilder, die abgerufen werden können. [Detail] Keine
Beispiele
Das folgende Codebeispiel zeigt eine Scanauftragsanforderung, wenn der Scan vom Scangerät initiiert wird.
<?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>
Das folgende Codebeispiel zeigt eine Scanauftragsanforderung, wenn der Scan von einer Anwendung auf dem Client initiiert wird.
<?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>