Funzione SetPort

La funzione SetPort imposta lo stato associato a una porta della stampante.

Sintassi

BOOL SetPort(
  _In_ LPTSTR pName,
  _In_ LPTSTR pPortName,
  _In_ DWORD  dwLevel,
  _In_ LPBYTE pPortInfo
);

Parametri

pName [in]

Puntatore a una stringa con terminazione zero che specifica il nome del server della stampante a cui è connessa la porta. Impostare questo parametro su NULL se la porta si trova nel computer locale.

pPortName [in]

Puntatore a una stringa con terminazione zero che specifica il nome della porta della stampante.

dwLevel [in]

Specifica il tipo di struttura a cui punta il parametro pPortInfo .

Questo valore deve essere 3, che corrisponde a una struttura di dati PORT_INFO_3 .

pPortInfo [in]

Puntatore a una struttura PORT_INFO_3 che contiene le informazioni sullo stato della porta da impostare.

Valore restituito

Se la funzione ha esito positivo, il valore restituito è un valore diverso da zero.

Se la funzione ha esito negativo, il valore restituito è zero.

Commenti

Nota

Si tratta di una funzione di blocco o sincrona e potrebbe non restituire immediatamente. La velocità con cui questa funzione restituisce dipende da fattori di runtime come lo stato della rete, la configurazione del server di stampa e i fattori di implementazione del driver della stampante difficili da prevedere durante la scrittura di un'applicazione. La chiamata a questa funzione da un thread che gestisce l'interazione con l'interfaccia utente potrebbe rendere l'applicazione non rispondente.

Il chiamante della funzione SetPort deve essere eseguito come amministratore. Inoltre, se il chiamante è un monitor porta o monitoraggio del linguaggio, deve chiamare RevertToSelf per terminare la rappresentazione prima di chiamare SetPort.

Tutti i programmi che chiamano SetPort devono avere SERVER_ACCESS_ADMINISTER accesso al server a cui è connessa la porta.

Quando si imposta un valore di stato della porta della stampante con il valore di gravità PORT_STATUS_TYPE_ERROR, lo spooler di stampa smette di inviare processi alla porta. Lo spooler di stampa riprende l'invio di processi alla porta quando lo stato della porta viene cancellato da un'altra chiamata a SetPort.

Requisiti

Requisito	Valore
Client minimo supportato	Windows 2000 Professional [solo app desktop]
Server minimo supportato	Windows 2000 Server [solo app desktop]
Intestazione	Winspool.h (include Windows.h)
Libreria	Winspool.lib
DLL	Winspool.drv
Nomi Unicode e ANSI	SetPortW (Unicode) e SetPortA (ANSI)

Vedi anche

Stampa

Funzioni dell'API spooler di stampa

PORT_INFO_3