NetLocalGroupSetInfo 函式 (lmaccess.h)

發行項
03/05/2024

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。

如果函式失敗，傳回值可以是下列其中一個錯誤碼。

傳回碼	Description
ERROR_ACCESS_DENIED	用戶無法存取要求的資訊。
ERROR_INVALID_PARAMETER	其中一個函式參數無效。如需詳細資訊，請參閱接下來的＜備註＞一節。
ERROR_NO_SUCH_ALIAS	指定的本地組不存在。
NERR_NotPrimary	此作業只允許在網域的主要域控制器上執行。
NERR_InvalidComputer	電腦名稱無效。

備註

如果您在執行 Active Directory 的域控制器上呼叫此函式，則會根據安全性實體對象的訪問控制清單 (ACL) ，允許或拒絕存取。預設 ACL 只允許網域管理員和帳戶操作員呼叫此函式。在成員伺服器或工作站上，只有系統管理員和 Power Users 可以呼叫此函式。如需詳細資訊，請參閱網路管理功能的安全性需求。如需 ACL、ACE 和存取令牌的詳細資訊，請參閱存取控制模型。

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 (包含 Lm.h)
程式庫	Netapi32.lib
Dll	Netapi32.dll