Função NetWkstaTransportEnum (lmwksta.h)

Artigo
02/28/2024

A função NetWkstaTransportEnum fornece informações sobre protocolos de transporte gerenciados pelo redirecionador, que é o software no computador cliente que gera solicitações de arquivo para o computador servidor.

Sintaxe

NET_API_STATUS NET_API_FUNCTION NetWkstaTransportEnum(
  [in]      LPTSTR  servername,
  [in]      DWORD   level,
  [out]     LPBYTE  *bufptr,
  [in]      DWORD   prefmaxlen,
  [out]     LPDWORD entriesread,
  [out]     LPDWORD totalentries,
  [in, out] LPDWORD resume_handle
);

Parâmetros

[in] servername

Um ponteiro para uma cadeia de caracteres que especifica o nome DNS ou NetBIOS do servidor remoto no qual a função deve ser executada. Se esse parâmetro for NULL, o computador local será usado.

[in] level

O nível de informações solicitadas para os dados. Esse parâmetro pode ser o valor a seguir.

Valor	Significado
0	Retornar informações de protocolo de transporte de estação de trabalho. O parâmetro bufptr aponta para uma matriz de estruturas WKSTA_TRANSPORT_INFO_0 .

[out] bufptr

Um ponteiro para o buffer que recebe os dados. O formato desses dados depende do valor do parâmetro level . Esse buffer é alocado pelo sistema e deve ser liberado usando a função NetApiBufferFree . Observe que você deve liberar o buffer mesmo que a função falhe com ERROR_MORE_DATA ou NERR_BufTooSmall.

[in] prefmaxlen

O comprimento máximo preferencial dos dados retornados, em bytes. Se você especificar MAX_PREFERRED_LENGTH, a função alocará a quantidade de memória necessária para os dados. Se você especificar outro valor nesse parâmetro, ele poderá restringir o número de bytes retornados pela função. Se o tamanho do buffer for insuficiente para manter todas as entradas, a função retornará ERROR_MORE_DATA ou NERR_BufTooSmall. Para obter mais informações, consulte Buffers de função de gerenciamento de rede e Comprimentos de buffer de função de gerenciamento de rede.

[out] entriesread

Um ponteiro para um valor que recebe a contagem de elementos realmente enumerados.

[out] totalentries

Um ponteiro para um valor que recebe o número total de entradas que poderiam ter sido enumeradas da posição de currículo atual. Observe que os aplicativos devem considerar esse valor apenas como uma dica.

[in, out] resume_handle

Um ponteiro para um valor que contém um identificador de retomada que é usado para continuar uma pesquisa de transporte de estação de trabalho existente. O identificador deve ser zero na primeira chamada e deixado inalterado para chamadas subsequentes. Se o parâmetro resumehandle for um ponteiro NULL , nenhum identificador de retomada será armazenado.

Retornar valor

Se a função for bem-sucedida, o valor retornado será NERR_Success.

Se a função falhar, o valor retornado poderá ser um dos códigos de erro a seguir.

Código de retorno	Descrição
ERROR_MORE_DATA	Mais entradas estão disponíveis. Especifique um buffer grande o suficiente para receber todas as entradas.
ERROR_INVALID_LEVEL	O parâmetro level, que indica qual nível de informações de estrutura de dados está disponível, é inválido. Esse erro será retornado se o parâmetro de nível for especificado como um valor diferente de zero.
ERROR_INVALID_PARAMETER	Um ou mais parâmetros eram inválidos. Esse erro será retornado se os parâmetros bufptr ou entriesread forem ponteiros NULL .
ERROR_NOT_ENOUGH_MEMORY	Memória insuficiente disponível para processar a solicitação.
ERROR_NOT_SUPPORTED	A solicitação não terá suporte. Esse erro será retornado se um servidor remoto tiver sido especificado no parâmetro servername e essa solicitação não tiver suporte no servidor remoto.
NERR_BufTooSmall	Mais entradas estão disponíveis. Especifique um buffer grande o suficiente para receber todas as entradas. Esse código de erro é definido no arquivo de cabeçalho Lmerr.h .

Comentários

Nenhuma associação de grupo especial é necessária para executar com êxito a função NetWkstaTransportEnum .

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows 2000 Professional [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows 2000 Server [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	lmwksta.h (inclua Lm.h)
Biblioteca	Netapi32.lib
DLL	Netapi32.dll