NetLocalGroupSetInfo 関数 (lmaccess.h)

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

NetLocalGroupSetInfo 関数は、既存のローカルグループの名前を変更します。関数は、コメントをローカルグループに関連付けます。

構文

NET_API_STATUS NET_API_FUNCTION NetLocalGroupSetInfo(
  [in]  LPCWSTR servername,
  [in]  LPCWSTR groupname,
  [in]  DWORD   level,
  [in]  LPBYTE  buf,
  [out] LPDWORD parm_err
);

パラメーター

[in] servername

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

[in] groupname

変更するローカルグループアカウントの名前を指定する定数文字列へのポインター。詳細については、「解説」を参照してください。

[in] level

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

値	意味
0	ローカルグループ名を指定します。 buf パラメーターは、LOCALGROUP_INFO_0構造体を指します。このレベルを使用して、既存のローカルグループの名前を変更します。
1	グループに関連付けるローカルグループ名とコメントを指定します。 buf パラメーターは、LOCALGROUP_INFO_1構造体を指します。
1002	ローカルグループに関連付けるコメントを指定します。 buf パラメーターは、LOCALGROUP_INFO_1002構造体を指します。

[in] buf

ローカルグループ情報を含むバッファーへのポインター。このデータの形式は 、level パラメーターの値によって異なります。詳細については、「ネットワーク管理機能バッファー」を参照してください。

[out] parm_err

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

戻り値

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

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

リターンコード	説明
ERROR_ACCESS_DENIED	ユーザーには、要求された情報へのアクセス権がありません。
ERROR_INVALID_PARAMETER	関数パラメーターの 1 つが無効です。詳細については、「解説」を参照してください。
ERROR_NO_SUCH_ALIAS	指定されたローカルグループが存在しません。
NERR_NotPrimary	操作は、ドメインのプライマリドメインコントローラーでのみ許可されます。
NERR_InvalidComputer	コンピューター名が無効です。

注釈

Active Directory を実行しているドメインコントローラーでこの関数を呼び出すと、セキュリティ保護可能なオブジェクトのアクセス制御リスト (ACL) に基づいてアクセスが許可または拒否されます。既定の ACL では、Domain Admins と Account Operators のみがこの関数を呼び出すように許可されます。メンバーサーバーまたはワークステーションでは、管理者と Power Users のみがこの関数を呼び出すことができます。詳細については、「ネットワーク管理機能のセキュリティ要件」を参照してください。 ACL、ACE、およびアクセストークンの詳細については、「Access Control モデル」を参照してください。

LocalGroup オブジェクトのセキュリティ記述子は、この関数のアクセスチェックを実行するために使用されます。通常、呼び出し元は、この関数の呼び出しを成功させるには、オブジェクト全体への書き込みアクセス権を持っている必要があります。

既存のローカルグループの新しい名前を指定するには、LOCALGROUP_INFO_0を指定して NetLocalGroupSetInfo を呼び出し、lgrpi0_name メンバーを使用して値を指定します。 LOCALGROUP_INFO_1を使用して NetLocalGroupSetInfo 関数を呼び出し、lgrpi1_name メンバーを使用して新しい値を指定した場合、その値は無視されます。

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

値	メンバー
LOCALGROUP_NAME_PARMNUM	lgrpi*_name
LOCALGROUP_COMMENT_PARMNUM	lgrpi*_comment

ユーザーアカウント名は 20 文字に制限され、グループ名は 256 文字に制限されます。さらに、アカウント名をピリオドで終えることはできません。また、コンマまたは印刷可能な文字を含めることはできません: "、/、、[、]、:、|、 <、 >、+、=、;、;、?、*。また、名前には、印刷できない 1 から 31 の範囲の文字を含めることはできません。

Active Directory のプログラミングを行う場合は、特定の Active Directory サービスインターフェイス (ADSI) メソッドを呼び出して、ネットワーク管理ローカルグループ関数を呼び出すことで実現できるのと同じ機能を実現できます。詳細については、「 IADsGroup」を参照してください。

要件

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