WSAEnumNameSpaceProvidersA 函数 (winsock2.h)

WSAEnumNameSpaceProviders 函数检索有关可用命名空间提供程序的信息。

语法

INT WSAAPI WSAEnumNameSpaceProvidersA(
  [in, out] LPDWORD              lpdwBufferLength,
  [out]     LPWSANAMESPACE_INFOA lpnspBuffer
);

参数

[in, out] lpdwBufferLength

在输入时,lpnspBuffer指向的缓冲区中包含的字节数。 在输出(如果函数失败,并且错误 WSAEFAULT),要传递的最小字节数,lpnspBuffer 以检索所有请求的信息。 传递给 WSAEnumNameSpaceProviders 的缓冲区必须足以容纳所有命名空间信息。

[out] lpnspBuffer

WSANAMESPACE_INFO 结构填充的缓冲区。 返回的结构连续位于缓冲区的头部。 结构中的指针引用的可变大小信息指向位于固定大小结构末尾和缓冲区末尾之间的缓冲区内的位置。 填充的结构数是 WSAEnumNameSpaceProviders的返回值。

返回值

WSAEnumNameSpaceProviders 函数返回复制到 lpnspBuffer中的 WSANAMESPACE_INFO 结构数。 否则,返回值SOCKET_ERROR,可以通过调用 WSAGetLastError来检索特定的错误号。

错误代码 意义
WSAEFAULT
lpnspBuffer 参数是 NULL 指针或缓冲区长度(lpdwBufferLength)太小,无法接收所有相关 WSANAMESPACE_INFO 结构和相关信息。 返回此错误后,lpdwBufferLength 参数中返回所需的缓冲区长度。
WSANOTINITIALIZED
尚未初始化WS2_32.DLL。 在调用任何 Windows 套接字函数之前,应用程序必须先调用 WSAStartup
WSA_NOT_ENOUGH_MEMORY
内存不足,无法执行操作。

言论

WSAEnumNameSpaceProviders 函数返回 lpnspBuffer 参数指向的缓冲区中可用命名空间提供程序的信息。 返回的缓冲区包含一个连续位于缓冲区头的 WSANAMESPACE_INFO 结构数组。 WSANAMESPACE_INFO 结构中的指针引用的可变大小信息指向位于固定 WSANAMESPACE_INFO 结构和缓冲区末尾之间的缓冲区内的位置。 填充的 WSANAMESPACE_INFO 结构数由
WSAEnumNameSpaceProviders 函数。

每个 WSANAMESPACE_INFO 结构条目都包含有关在安装命名空间提供程序时传递给 WSCInstallNameSpace 的命名空间条目和 WSCInstallNameSpace32 函数的提供程序特定信息。

WSAEnumNameSpaceProvidersEx 函数是 WSAEnumNameSpaceProviders 函数的增强版本。 WSCEnumNameSpaceProvidersEx32 函数是 WSAEnumNameSpaceProviders 函数的增强版本,用于返回有关在 64 位平台上使用的可用 32 位命名空间提供程序的信息。

示例代码

以下示例演示了如何使用 WSAEnumNameSpaceProviders 函数检索有关可用命名空间提供程序的信息。
#ifndef UNICODE
#define UNICODE 1
#endif

#include <winsock2.h>
#include <ws2tcpip.h>
#include <objbase.h>
#include <stdio.h>

// Link with ws2_32.lib and ole32.lib
#pragma comment (lib, "Ws2_32.lib")
#pragma comment (lib, "ole32.lib")

#define MALLOC(x) HeapAlloc(GetProcessHeap(), 0, (x))
#define FREE(x) HeapFree(GetProcessHeap(), 0, (x))
// Note: could also use malloc() and free()

int wmain()
{

    //-----------------------------------------
    // Declare and initialize variables
    WSADATA wsaData;
    int iResult;
    int iError = 0;

    INT iNuminfo = 0;

    int i;
    

    // Allocate a 4K buffer to retrieve all the namespace providers
    DWORD dwInitialBufferLen = 4096;
    DWORD dwBufferLen;
    LPWSANAMESPACE_INFO lpProviderInfo;
    
    
    // variables needed for converting provider GUID to a string
    int iRet = 0;
    WCHAR GuidString[40] = {0};

    // Set dwBufferLen to the initial buffer length
    dwBufferLen = dwInitialBufferLen;
    
    // Initialize Winsock
    iResult = WSAStartup(MAKEWORD(2, 2), &wsaData);
    if (iResult != 0) {
        wprintf(L"WSAStartup failed: %d\n", iResult);
        return 1;
    }
    
    lpProviderInfo = (LPWSANAMESPACE_INFO) MALLOC(dwBufferLen);
    if (lpProviderInfo == NULL) {
        wprintf(L"Memory allocation for providers buffer failed\n");
        WSACleanup();
        return 1;
    }
    
    iNuminfo = WSAEnumNameSpaceProviders(&dwBufferLen, lpProviderInfo);
    if (iNuminfo == SOCKET_ERROR) {
        iError = WSAGetLastError();
        if (iError == WSAEFAULT && dwBufferLen != dwInitialBufferLen) {
            wprintf(L"WSAEnumNameSpaceProviders failed with too small a buffer\n");
            wprintf(L"  Increasing the buffer to %u\n\n", dwBufferLen);
            if (lpProviderInfo) {
               FREE(lpProviderInfo);
               lpProviderInfo = NULL;
            }        

            lpProviderInfo = (LPWSANAMESPACE_INFO) MALLOC(dwBufferLen);
            if (lpProviderInfo == NULL) {
                wprintf(L"Memory allocation for providers buffer failed\n");
                WSACleanup();
               return 1;
            }

            iNuminfo = WSAEnumNameSpaceProviders(&dwBufferLen, lpProviderInfo);
            if (iNuminfo == SOCKET_ERROR) {
               wprintf(L"WSAEnumNameSpaceProviders failed with error: %d\n",
                  WSAGetLastError() );
               if (lpProviderInfo) {
                  FREE(lpProviderInfo);
                  lpProviderInfo = NULL;
               }        
               WSACleanup();
               return 1;
            }
            else
                wprintf(L"\n");   
        } 
        else {   
            wprintf(L"WSAEnumNameSpaceProviders failed with error: %d\n",
               WSAGetLastError() );
            if (lpProviderInfo) {
               FREE(lpProviderInfo);
               lpProviderInfo = NULL;
            }        
           WSACleanup();
           return 1;
        } 
     }

       wprintf(L"WSAEnumNameSpaceProviders succeeded with provider data count = %d\n\n",
           iNuminfo);
       for (i= 0; i < iNuminfo; i++) {
            iRet = StringFromGUID2(lpProviderInfo[i].NSProviderId, (LPOLESTR) &GuidString, 39); 
            if (iRet == 0)
                wprintf(L"StringFromGUID2 failed\n");
            else 
                wprintf(L"NameSpace ProviderId[%u] = %ws\n",i, GuidString);

           wprintf(L"NameSpace[%u] = ", i);
           switch (lpProviderInfo[i].dwNameSpace) {
           case NS_DNS:
               wprintf(L"Domain Name System (NS_DNS)\n");
               break;
           case NS_WINS:
               wprintf(L"Windows Internet Naming Service (NS_WINS)\n");
               break;
           case NS_NETBT:
               wprintf(L"NetBIOS (NS_NETBT)\n");
               break;
           case NS_NTDS:
               wprintf(L"Windows NT Directory Services (NS_NTDS)\n");
               break;
           case NS_NLA:
               wprintf(L"Network Location Awareness (NS_NLA)\n");
               break;
           // following values only defined on Vista and later
#if(_WIN32_WINNT >= 0x0600)
           case NS_BTH:
               wprintf(L"Bluetooth (NS_BTH)\n");
               break;
           case NS_EMAIL:
               wprintf(L"Email (NS_EMAIL)\n");
               break;
           case NS_PNRPNAME:
               wprintf(L"Peer-to-peer (NS_PNRPNAME)\n");
               break;
           case NS_PNRPCLOUD:
               wprintf(L"Peer-to-peer collection (NS_PNRPCLOUD)\n");
               break;
#endif
           default:
               wprintf(L"Other value (%u)\n", lpProviderInfo[i].dwNameSpace);             
               break;
           }    

           if (lpProviderInfo[i].fActive)
               wprintf(L"Namespace[%u] is active\n", i);
           else    
               wprintf(L"Namespace[%u] is inactive\n", i);

           wprintf(L"NameSpace Version[%u] = %u\n", i, lpProviderInfo[i].dwVersion);

           wprintf(L"Namespace Identifier[%u] = %ws\n\n", i, lpProviderInfo[i].lpszIdentifier);
       }           

    if (lpProviderInfo) {
        FREE(lpProviderInfo);
        lpProviderInfo = NULL;
    }        
    WSACleanup();
    
    return 0;
}

Windows Phone 8: Windows Phone 8 及更高版本的 Windows Phone 应用商店应用支持 WSAEnumNameSpaceProvidersW 功能。

Windows 8.1Windows Server 2012 R2:Windows 8.1、Windows Server 2012 R2 及更高版本上的 Windows 应用商店应用支持 WSAEnumNameSpaceProvidersW 函数。

注意

winsock2.h 标头将 WSAEnumNameSpaceProviders 定义为一个别名,该别名根据 UNICODE 预处理器常量的定义自动选择此函数的 ANSI 或 Unicode 版本。 将中性编码别名与不中性编码的代码混合使用可能会导致编译或运行时错误不匹配。 有关详细信息,请参阅函数原型的 约定。

要求

要求 价值
最低支持的客户端 Windows 8.1、Windows Vista [桌面应用 |UWP 应用]
支持的最低服务器 Windows Server 2003 [桌面应用 |UWP 应用]
目标平台 窗户
标头 winsock2.h
Ws2_32.lib
DLL Ws2_32.dll

另请参阅

WSAEnumNameSpaceProvidersEx

WSAGetLastError

WSANAMESPACE_INFO

WSAStartup

WSCEnumNameSpaceProvidersEx32

WSCInstallNameSpace

WSCInstallNameSpaceEx

Winsock 函数

Winsock 参考