Função WNetEnumResourceA (winnetwk.h)

Artigo
11/20/2024

A função WNetEnumResource continua uma enumeração de recursos de rede que foi iniciada por uma chamada para a função de WNetOpenEnum .

Sintaxe

DWORD WNetEnumResourceA(
  [in]      HANDLE  hEnum,
  [in, out] LPDWORD lpcCount,
  [out]     LPVOID  lpBuffer,
  [in, out] LPDWORD lpBufferSize
);

Parâmetros

[in] hEnum

Identificador que identifica uma instância de enumeração. Esse identificador deve ser retornado pela função WNetOpenEnum.

[in, out] lpcCount

Ponteiro para uma variável que especifica o número de entradas solicitadas. Se o número solicitado for –1, a função retornará o máximo de entradas possível.

Se a função for bem-sucedida, ao retornar a variável apontada por esse parâmetro, conterá o número de entradas realmente lidas.

[out] lpBuffer

Ponteiro para o buffer que recebe os resultados da enumeração. Os resultados são retornados como uma matriz de estruturas de NETRESOURCE . Observe que o buffer alocado deve ser grande o suficiente para manter as estruturas, além das cadeias de caracteres para as quais seus membros apontam. Para obter mais informações, consulte a seção Comentários a seguir.

O buffer é válido até a próxima chamada usando o identificador especificado pelo parâmetro hEnum. A ordem de estruturas de NETRESOURCE na matriz não é previsível.

[in, out] lpBufferSize

Ponteiro para uma variável que especifica o tamanho do parâmetro lpBuffer, em bytes. Se o buffer for muito pequeno para receber até mesmo uma entrada, esse parâmetro receberá o tamanho necessário do buffer.

Valor de retorno

Se a função for bem-sucedida, o valor retornado será um dos valores a seguir.

Código de retorno	Descrição
NO_ERROR	A enumeração foi bem-sucedida e o buffer contém os dados solicitados. O aplicativo de chamada pode continuar chamando WNetEnumResource para concluir a enumeração.
ERROR_NO_MORE_ITEMS	Não há mais entradas. O conteúdo do buffer é indefinido.

Se a função falhar, o valor retornado será um código de erro do sistema, como um dos valores a seguir.

Código de retorno	Descrição
ERROR_MORE_DATA	Mais entradas estão disponíveis com chamadas subsequentes. Para obter mais informações, consulte a seção Comentários a seguir.
ERROR_INVALID_HANDLE	O identificador especificado pelo parâmetro hEnum não é válido.
ERROR_NO_NETWORK	A rede não está disponível. (Essa condição é testada antes que hEnum seja testado para validade.)
ERROR_EXTENDED_ERROR	Ocorreu um erro específico da rede. Para obter uma descrição do erro, chame a função WNetGetLastError.

Observações

A função WNetEnumResource não enumera usuários conectados a um compartilhamento; você pode chamar a função NetConnectionEnum para realizar essa tarefa. Para enumerar compartilhamentos ocultos, chame a função NetShareEnum.

Um aplicativo não pode definir o parâmetro lpBuffer para NULL e recuperar o tamanho do buffer necessário do parâmetro lpBufferSize. Em vez disso, o aplicativo deve alocar um buffer de um tamanho razoável — 16 quilobytes é típico — e usar o valor de lpBufferSize para detecção de erros.

Exemplos

Para obter um exemplo de código que ilustra uma função definida pelo aplicativo que enumera todos os recursos em uma rede, consulte Enumerando recursos de rede.

Nota

O cabeçalho winnetwk.h define WNetEnumResource como um alias que seleciona automaticamente a versão ANSI ou Unicode dessa função com base na definição da constante do pré-processador UNICODE. A combinação do uso do alias neutro de codificação com código que não é neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Conventions for Function Prototypes.

Requisitos

Requisito	Valor
de cliente com suporte mínimo	Windows 2000 Professional [somente aplicativos da área de trabalho]
servidor com suporte mínimo	Windows 2000 Server [somente aplicativos da área de trabalho]
da Plataforma de Destino	Windows
cabeçalho	winnetwk.h
biblioteca	Mpr.lib
de DLL	Mpr.dll

Consulte também

NETRESOURCE

WNetCloseEnum

WNetOpenEnum

Visão geral WNet (Rede windows)

funções de rede do Windows

Compartilhar via