NetWkstaTransportEnum 関数 (lmwksta.h)

[アーティクル]
08/24/2023

NetWkstaTransportEnum 関数は、リダイレクターによって管理されるトランスポートプロトコルに関する情報を提供します。これは、サーバーコンピューターにファイル要求を生成するクライアントコンピューター上のソフトウェアです。

構文

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
);

パラメーター

[in] servername

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

[in] level

データに対して要求される情報のレベル。このパラメーターには、次の値を指定できます。

値	意味
0	ワークステーションのトランスポートプロトコル情報を返します。 bufptr パラメーターは、WKSTA_TRANSPORT_INFO_0構造体の配列を指します。

[out] bufptr

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

[in] prefmaxlen

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

[out] entriesread

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

[out] totalentries

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

[in, out] resume_handle

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

戻り値

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

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

リターンコード	説明
ERROR_MORE_DATA	その他のエントリを使用できます。すべてのエントリを受信するのに十分な大きさのバッファーを指定します。
ERROR_INVALID_LEVEL	level パラメーターは、使用できるデータ構造情報のレベルを示しますが、無効です。このエラーは、 level パラメーターが 0 以外の値として指定されている場合に返されます。
ERROR_INVALID_PARAMETER	1 つ以上のパラメーターが無効でした。このエラーは、 bufptr パラメーターまたは entriesread パラメーターが NULL ポインターである場合に返されます。
ERROR_NOT_ENOUGH_MEMORY	要求を処理するために使用できるメモリが不足していました。
ERROR_NOT_SUPPORTED	要求はサポートされていません。このエラーは、リモートサーバーが servername パラメーターで指定されていて、この要求がリモートサーバーでサポートされていない場合に返されます。
NERR_BufTooSmall	その他のエントリを使用できます。すべてのエントリを受信するのに十分な大きさのバッファーを指定します。このエラーコードは、Lmerr.h ヘッダーファイルで定義されています。

注釈

NetWkstaTransportEnum 関数を正常に実行するために、特別なグループメンバーシップは必要ありません。

要件

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