NetServerTransportEnum 関数 (lmserver.h)

[アーティクル]
02/28/2024

NetServerTransportEnum 関数は、サーバーによって管理されるトランスポートプロトコルに関する情報を提供します。

構文

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

パラメーター

[in] servername

関数を実行するリモートサーバーの DNS または NetBIOS 名を指定する文字列へのポインター。このパラメーターが NULL の場合は、ローカルコンピューターが使用されます。

[in] level

データの情報レベルを指定します。このパラメーターには、次の値のいずれかを指定できます。

値	意味
0	ネットワーク上の名前、アドレス、場所など、トランスポートプロトコルに関する情報を返します。 bufptr パラメーターは、SERVER_TRANSPORT_INFO_0構造体の配列を指します。
1	名前、アドレス、ネットワークの場所、ドメインなど、トランスポートプロトコルに関する情報を返します。 bufptr パラメーターは、SERVER_TRANSPORT_INFO_1構造体の配列を指します。

[out] bufptr

データを受信するバッファーへのポインター。このデータの形式は 、level パラメーターの値によって異なります。このバッファーはシステムによって割り当てられ、 NetApiBufferFree 関数を使用して解放する必要があります。関数がERROR_MORE_DATAで失敗した場合でも、バッファーを解放する必要があることに注意してください。

[in] prefmaxlen

返されるデータの推奨される最大長をバイト単位で指定します。 MAX_PREFERRED_LENGTHを指定すると、データに必要なメモリ量が関数によって割り当てられます。このパラメーターに別の値を指定すると、関数から返されるバイト数を制限できます。バッファーサイズが不十分で、すべてのエントリを保持するには、関数は ERROR_MORE_DATAを返します。詳細については、「ネットワーク管理機能バッファー」および「ネットワーク管理機能バッファーの長さ」を参照してください。

[out] entriesread

実際に列挙された要素の数を受け取る値へのポインター。

[out] totalentries

現在の再開位置から列挙された可能性があるエントリの合計数を受け取る値へのポインター。アプリケーションでは、この値をヒントとしてのみ考慮する必要があることに注意してください。

[in, out] resume_handle

既存のサーバートランスポート検索を続行するために使用される再開ハンドルを含む値へのポインター。最初の呼び出しではハンドルを 0 にし、後続の呼び出しでは変更しない必要があります。このパラメーターが NULL の場合、再開ハンドルは格納されません。

戻り値

関数が成功した場合、戻り値はNERR_Success。

関数が失敗した場合、戻り値は次のいずれかのエラーコードになります。

リターンコード	説明
ERROR_INVALID_LEVEL	level パラメーターに指定された値が無効です。
ERROR_MORE_DATA	その他のエントリを使用できます。すべてのエントリを受信するのに十分な大きさのバッファーを指定します。
ERROR_NOT_ENOUGH_MEMORY	十分なメモリがありません。
NERR_BufTooSmall	指定されたバッファーが小さすぎます。

注釈

この関数を正常に呼び出すことができるのは、認証済みユーザーのみです。Windows XP/2000: この関数を正常に実行するために、特別なグループメンバーシップは必要ありません。

例

次のコードサンプルは、 NetServerTransportEnum 関数の呼び出しを使用して、サーバーによって管理されるトランスポートプロトコルに関する情報を取得する方法を示しています。このサンプルでは、情報レベル 0 ( SERVER_TRANSPORT_INFO_0) を指定して NetServerTransportEnum を呼び出します。このサンプルでは、各トランスポートプロトコルの名前と列挙された合計数を出力します。最後に、コードサンプルでは、情報バッファーに割り当てられたメモリを解放します。

#ifndef UNICODE
#define UNICODE
#endif
#pragma comment(lib, "netapi32.lib")

#include <stdio.h>
#include <assert.h>
#include <windows.h> 
#include <lm.h>

int wmain(int argc, wchar_t *argv[])
{
   LPSERVER_TRANSPORT_INFO_0 pBuf = NULL;
   LPSERVER_TRANSPORT_INFO_0 pTmpBuf;
   DWORD dwLevel = 0;
   DWORD dwPrefMaxLen = MAX_PREFERRED_LENGTH;
   DWORD dwEntriesRead = 0;
   DWORD dwTotalEntries = 0;
   DWORD dwResumeHandle = 0;
   DWORD dwTotalCount = 0;
   NET_API_STATUS nStatus;
   LPTSTR pszServerName = NULL;
   DWORD i;

   if (argc > 2)
   {
      fwprintf(stderr, L"Usage: %s [\\\\ServerName]\n", argv[0]);
      exit(1);
   }
   // The server is not the default local computer.
   //
   if (argc == 2)
      pszServerName = (LPTSTR) argv[1];
   //
   // Call the NetServerTransportEnum function; specify level 0.
   //
   do // begin do
   {
      nStatus = NetServerTransportEnum(pszServerName,
                                       dwLevel,
                                       (LPBYTE *) &pBuf,
                                       dwPrefMaxLen,
                                       &dwEntriesRead,
                                       &dwTotalEntries,
                                       &dwResumeHandle);
      //
      // If the call succeeds,
      //
      if ((nStatus == NERR_Success) || (nStatus == ERROR_MORE_DATA))
      {
         if ((pTmpBuf = pBuf) != NULL)
         {
            //
            // Loop through the entries;
            //  process access errors.
            //
            for (i = 0; i < dwEntriesRead; i++)
            {
               assert(pTmpBuf != NULL);

               if (pTmpBuf == NULL)
               {
                  fprintf(stderr, "An access violation has occurred\n");
                  break;
               }
               //
               // Print the transport protocol name. 
               //
               wprintf(L"\tTransport: %s\n", pTmpBuf->svti0_transportname);

               pTmpBuf++;
               dwTotalCount++;
            }
         }
      }
      //
      // Otherwise, indicate a system error.
      //
      else
         fprintf(stderr, "A system error has occurred: %d\n", nStatus);

      //
      // Free the allocated buffer.
      //
      if (pBuf != NULL)
      {
         NetApiBufferFree(pBuf);
         pBuf = NULL;
      }
   // 
   // Continue to call NetServerTransportEnum while 
   //  there are more entries. 
   // 
   }
   while (nStatus == ERROR_MORE_DATA); // end do

   // Check again for an allocated buffer.
   //
   if (pBuf != NULL)
      NetApiBufferFree(pBuf);
   //
   // Print the final count of transports enumerated.
   //
   fprintf(stderr, "\nTotal of %d entries enumerated\n", dwTotalCount);

   return 0;
}

要件

要件	値
サポートされている最小のクライアント	Windows 2000 Professional [デスクトップアプリのみ]
サポートされている最小のサーバー	Windows 2000 Server [デスクトップアプリのみ]
対象プラットフォーム	Windows
ヘッダー	lmserver.h (Include Lm.h)
Library	Netapi32.lib
[DLL]	Netapi32.dll