Função XcvOpenPort (winsplp.h)

Artigo
03/01/2024

Uma função XcvOpenPort do servidor de monitor de porta abre uma porta para operações de configuração.

Sintaxe

BOOL XcvOpenPort(
  LPCWSTR     pszObject,
  ACCESS_MASK GrantedAccess,
  PHANDLE     phXcv
);

Parâmetros

pszObject

Ponteiro fornecido pelo chamador para uma cadeia de caracteres que representa o nome da porta. Pode ser NULL e a maioria dos monitores não precisa desse parâmetro.

GrantedAccess

A estrutura de ACCESS_MASK fornecida pelo chamador que contém o acesso concedido ao usuário durante uma chamada da DLL da interface do usuário do monitor de impressão para a função OpenPrinter do spooler . Consulte a seção Comentários a seguir.

phXcv

Ponteiro fornecido pelo chamador para um local para receber um identificador de porta fornecido pela função.

Retornar valor

Se a operação for bem-sucedida, a função deverá retornar TRUE. Caso contrário, ele deverá retornar FALSE.

Comentários

As DLLs do servidor de monitor de porta são necessárias para definir uma função XcvOpenPort e incluir seu endereço em uma estrutura MONITOR2 .

A função OpenPrinter do spooler (descrita na documentação do SDK do Microsoft Windows) chama XcvOpenPort se o nome da impressora especificado incluir uma das cadeias de caracteres "XcvPort" ou "XcvMonitor". Para obter mais informações, consulte AddPortUI.

A função XcvOpenPort deve abrir a porta para fins de configuração. Essa operação pode consistir apenas em armazenar os argumentos de entrada para uso subsequente no XcvDataPort. A função deve retornar um identificador para as informações armazenadas no local apontado por phXcv. Esse identificador é retornado ao chamador do OpenPrinter e, posteriormente, recebido como um argumento de entrada para XcvDataPort.

A função deve salvar a máscara de acesso concedida. Posteriormente, quando a função XcvDataPort da DLL do servidor for chamada, o acesso concedido deverá ser comparado com SERVER_ACCESS_ADMINISTER e, se a comparação falhar, XcvDataPort deverá retornar ERROR_ACCESS_DENIED.