Elemento CreateScanJobRequest
L'operazione CreateScanJobRequest necessaria prepara un dispositivo di analisi da analizzare.
Utilizzo
<wscn:CreateScanJobRequest>
child elements
</wscn:CreateScanJobRequest>
Attributi
Non sono presenti attributi.
Valore di testo
None
Elementi figlio
| Elemento |
|---|
| DestinationToken |
| ScanIdentifier |
| ScanTicket |
Elementi padre
Non sono presenti elementi padre.
Osservazioni:
Il servizio di analisi WSD deve supportare l'operazione CreateScanJobRequest .
L'operazione CreateScanJobRequest è il meccanismo principale per preparare un dispositivo di analisi per analizzare le immagini disponibili. Questa operazione può essere avviata in due metodi diversi. Ogni metodo invierà argomenti diversi a CreateScanJobRequest. I due metodi e gli argomenti sono:
L'utente seleziona una destinazione e preme il pulsante di analisi nel dispositivo. In questo metodo il client invia un oggetto CreateScanJobRequest con gli elementi figlio seguenti:
Elemento ScanIdentifier restituito dal servizio di analisi al client tramite ScanAvailableEvent. Il servizio di analisi deve controllare questo identificatore per assicurarsi che il client corretto richieda l'analisi dopo che l'utente ha selezionato la destinazione.
Elemento DestinationToken restituito dal servizio di analisi WSD al client quando ha sottoscritto per ricevere gli eventi ScanAvailableEvent. Il servizio di analisi deve verificare che il client corretto richieda l'analisi controllando questo token.
Elemento ScanTicket per controllare l'elaborazione dell'analisi. I valori nel ticket di analisi sono i valori predefiniti impostati nel client prima che l'utente sia passato al dispositivo per avviare l'analisi.
L'utente avvia un'applicazione nel client e acquisisce un'immagine. In questo metodo il client invia CreateScanJobRequest solo con l'elemento ScanTicket .
Alcuni elementi all'interno della gerarchia CreateScanJobRequest possono contenere l'attributo Boolean MustHonor . Se MustHonor è presente e true, il servizio di analisi WSD deve rispettare l'elemento richiesto e il relativo valore o rifiutare la richiesta di processo di analisi. Se un elemento non supportato non dispone di un attributo MustHonor o se il relativo attributo MustHonor è false, il servizio di analisi WSD deve ignorarlo. Se l'attributo MustHonor di un elemento supportato è false, il servizio di analisi WSD deve sostituire il valore richiesto con quello supportato.
Se il client fornisce una combinazione in conflitto di elementi nella richiesta di processo di analisi (ad esempio InputSource e Risoluzione), il servizio di analisi WSD deve rifiutare la richiesta del processo di analisi se gli elementi in conflitto hanno un valore di attributo MustHonor true.
Gli elementi seguenti possono avere l'attributo MustHonor: ColorProcessing, CompressionQualityFactor, ContentType, Exposure, FilmScanMode, ImagesToTransfer, InputSize, InputSource, MediaSides, Resolution, Rotation , Scaling, ScanRegionHeight, ScanRegionWidth, ScanRegionXOffset e ScanRegionYOffset.
Questa operazione può restituire tutti i codici di errore comuni del servizio di analisi WSD. Per altre informazioni su come segnalare gli errori, vedere Segnalazione errori del servizio di analisi WSD.
CreateScanJobRequest può restituire anche gli errori seguenti:
ServerErrorNotAcceptingJobs Il server non può accettare un nuovo processo di analisi. Questo errore può verificarsi perché lo scanner è stato messo in modalità servizio o perché è presente una condizione di intervento dell'utente e tutti i buffer di memoria sono stati esauriti. Il client può provare nuovamente la richiesta non modificata in un secondo momento, con una previsione che il server sia diventato sbloccato e che lo scanner accetti nuovamente i processi.
Proprietà Fault Definizione [Codice] soap:Receiver [Codice secondario] wscn:ServerErrorNotAcceptingJobs [Motivo] Il servizio viene temporaneamente bloccato e non può accettare nuove richieste di processo o documenti. [Dettaglio] None ClientErrorFormatNotSupported Lo scanner non supporta il valore Di formato fornito.
Proprietà Fault Definizione [Codice] soap:Sender [Codice secondario] wscn:ClientErrorFormatNotSupported [Motivo] Il valore del parametro Formato documento non è supportato. [Dettaglio] Facoltativo. Il servizio di analisi può restituire un elenco di formati supportati. I dati in questo elemento devono essere di tipo <wscn:FormatSupportedType>. ClientErrorInvalidScanIdentifier Il valore ScanIdentifier fornito non è attualmente valido all'interno del dispositivo di analisi.
Proprietà Fault Definizione [Codice] soap:Sender [Codice secondario] wscn:ClientErrorInvalidScanIdentifier [Motivo] Il valore del parametro ScanIdentifier non è attualmente valido. [Dettaglio] None ClientErrorInvalidDestinationToken Il valore DestinationToken fornito non è valido per il dispositivo di analisi.
Proprietà Fault Definizione [Codice] soap:Sender [Codice secondario] wscn:ClientErrorInvalidDestinationToken [Motivo] Il valore del parametro DestinationToken non è attualmente valido. [Dettaglio] None ClientErrorNoImagesAvailable Il server non può accettare un nuovo processo di analisi perché non è presente alcun supporto da analizzare. Ad esempio, questo errore viene generato quando viene eseguito un processo di analisi dal feed automatico di documenti collegato allo scanner e il feeder è vuoto. Il client può provare nuovamente la richiesta non modificata in un secondo momento, con l'aspettativa che la condizione sia stata risolta e che lo scanner disponga ora di supporti da analizzare.
Proprietà Fault Definizione [Codice] soap:Sender [Codice secondario] wscn:ClientErrorNoImagesAvailable [Motivo] Il server non dispone di immagini disponibili per l'acquisizione. [Dettaglio] None
Esempi
L'esempio di codice seguente mostra una richiesta di processo di analisi quando l'analisi viene avviata dal dispositivo di analisi.
<?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>
L'esempio di codice seguente mostra una richiesta di processo di analisi quando l'analisi viene avviata da un'applicazione nel client.
<?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>