NetWkstaSetInfo 関数 (lmwksta.h)

NetWkstaSetInfo 関数は、システムが再初期化された後も有効な情報を持つワークステーションを構成します。

構文

NET_API_STATUS NET_API_FUNCTION NetWkstaSetInfo(
  [in]  LMSTR   servername,
  [in]  DWORD   level,
  [in]  LPBYTE  buffer,
  [out] LPDWORD parm_err
);

パラメーター

[in] servername

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

[in] level

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

レベル 1010 から 1013、1018、1023、1027、1028、1032、1033、1035、または 1041 から 1062 を設定しないでください。

[in] buffer

データを指定するバッファーへのポインター。 このデータの形式は、 level パラメーターの値によって異なります。 詳細については、「 ネットワーク管理関数バッファー」を参照してください。

[out] parm_err

ERROR_INVALID_PARAMETER エラーの原因となるワークステーション情報構造体の最初のメンバーのインデックスを受け取る値へのポインター。 このパラメーターが NULL の場合、エラー時にインデックスは返されません。 詳細については、「解説」を参照してください。

戻り値

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

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

注釈

リモート サーバーで NetWkstaSetInfo 関数を正常に実行できるのは、Administrators グループのメンバーだけです。

NetWkstaSetInfo 関数は、ローカル システムまたはリモート システム上のワークステーション サービスを呼び出します。 NetWkstaSetInfo 関数を使用して実際に変更できるのは、WKSTA_INFO_502構造体のメンバーの数に制限があります。 ワークステーション・サービスによって無視されるメンバーが設定されている場合、エラーは返されません。 ワークステーション サービスは、主にレジストリの設定を使用して構成されます。

NetWkstaSetInfo 関数の代わりに NetWkstaUserSetInfo 関数を使用して、ローカル システムの構成情報を設定できます。 NetWkstaUserSetInfo 関数は、ローカル セキュリティ機関 (LSA) を呼び出します。

NetWkstaSetInfo 関数がERROR_INVALID_PARAMETERを返す場合は、parm_err パラメーターを使用して、ワークステーション情報構造体の最初のメンバーが無効であることを示すことができます。 (ワークステーション情報構造はWKSTA_INFO_で始まり、その形式は level パラメーターで指定されます。次の表に、 parm_err パラメーターで返すことができる値と、エラーが発生している対応する構造体メンバーを示します。 (プレフィックス wki*_ は、メンバーが複数のプレフィックス (wki100_やwki402_など) で始めることができることを示します。

ワークステーション サービス パラメーターの設定は、LAN マネージャーで以前に使用した LanMan.ini ファイルではなく、レジストリに格納されます。 NetWkstaSetInfo 関数は、LanMan.ini ファイル内の値を変更しません。 ワークステーション サービスが停止して再起動されると、ワークステーション パラメーターはレジストリで指定された既定値にリセットされます (コマンド ライン パラメーターで上書きされない限り)。 以前の NetWkstaSetInfo の呼び出しによって設定された値は、ワークステーション パラメーターがリセットされると上書きされる可能性があります。

例

次のコード サンプルでは、 NetServerSetInfo 関数の呼び出しを使用して、ワークステーションに関連付けられているセッション タイムアウト値を設定する方法を示します。 (セッションタイムアウトは、非アクティブなセッションを切断するまでにサーバーが待機する秒数です。コードは、情報レベル 502 (WKSTA_INFO_502) を指定します。

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

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

int wmain(int argc, wchar_t *argv[])
{
   LPWKSTA_INFO_502 pBuf = NULL;
   WKSTA_INFO_502 wi;
   DWORD dwLevel = 502;
   NET_API_STATUS nStatus;
   LPWSTR pszServerName = NULL;

   if ((argc < 2) || (argc > 3))
   {
      fwprintf(stderr, L"Usage: %s [\\\\ServerName] SessionTimeOut\n", argv[0]);
      exit(1);
   }

   if (argc == 3)
      pszServerName = argv[1];
   //
   // Retrieve the current settings.
   //
   nStatus = NetWkstaGetInfo(pszServerName,
                             dwLevel,
                             (LPBYTE *)&pBuf);

   if (nStatus != NERR_Success)
   {
      fprintf(stderr, "A system error has occurred (NetWkstaGetInfo): %d\n", nStatus);
      return -1;
   }

   if (pBuf != NULL)
   {
      //
      // Copy the existing settings to the new structure,
      //   and free the buffer.
      //
      CopyMemory(&wi, pBuf, sizeof(wi));
      NetApiBufferFree(pBuf);
   }
   else
   {
      fprintf(stderr, "Memory invalid!\n");
      return -1;
   }
   //
   // Set a new session time-out value by
   //   calling the NetWkstaSetInfo function.
   //
   wi.wki502_sess_timeout = _wtoi(argv[argc-1]);
   nStatus = NetWkstaSetInfo(pszServerName,
                             dwLevel,
                             (LPBYTE)&wi,
                             NULL);
   //
   // Display the result of the call.
   //
   if (nStatus == NERR_Success)
      fwprintf(stderr, L"Workstation information reset: session time-out = %d\n", _wtoi(argv[argc-1]));
   else
      fprintf(stderr, "A system error has occurred (NetWkstaSetInfo): %d\n", nStatus);

   return 0;
}

要件

こちらもご覧ください

NetWkstaGetInfo

NetWkstaUserGetInfo

NetWkstaUserSetInfo

ネットワーク管理機能

ネットワーク管理の概要

ワークステーションとワークステーションのユーザー機能