NetShareSetInfo 函式 (lmshare.h)

發行項
08/24/2023

設定共用資源的參數。

語法

NET_API_STATUS NET_API_FUNCTION NetShareSetInfo(
  [in]  LMSTR   servername,
  [in]  LMSTR   netname,
  [in]  DWORD   level,
  [in]  LPBYTE  buf,
  [out] LPDWORD parm_err
);

參數

[in] servername

字串的指標，指定函式執行所在遠端伺服器的 DNS 或 NetBIOS 名稱。如果此參數為 Null，則會使用本機電腦。

[in] netname

字串的指標，指定要設定資訊的共用名稱稱。

[in] level

指定資料的資訊層級。此參數可以是下列其中一個值。

值	意義
1	指定共用資源的相關資訊，包括資源的名稱和類型，以及與資源相關聯的批註。 buf參數指向SHARE_INFO_1結構。
2	指定共用資源的相關資訊，包括資源的名稱、類型和許可權、密碼和連線數目。 buf參數指向SHARE_INFO_2結構。
502	指定共用資源的相關資訊，包括資源的名稱和類型、必要許可權、連線數目和其他相關資訊。 buf參數指向SHARE_INFO_502結構。
503	指定共用資源的名稱。 buf參數指向SHARE_INFO_503結構。 NetShareSetInfo函式會忽略此結構的所有成員shi503_servername。 Windows Server 2003 和 Windows XP：不支援此資訊層級。
1004	指定與共用資源相關聯的批註。 buf參數指向SHARE_INFO_1004結構。
1005	指定描述共用資源的一組旗標。 buf參數指向SHARE_INFO_1005結構。
1006	指定共用資源可容納的最大並行連線數目。 buf參數指向SHARE_INFO_1006結構。
1501	指定與指定共用相關聯的 SECURITY_DESCRIPTOR 。 buf參數指向SHARE_INFO_1501結構。

[in] buf

指定資料的緩衝區指標。此資料的格式取決於 level 參數的值。如需詳細資訊，請參閱網路管理功能緩衝區。

[out] parm_err

值指標，這個值會接收造成 ERROR_INVALID_PARAMETER 錯誤之共用資訊結構之第一個成員的索引。如果此參數為 Null，則不會在錯誤時傳回索引。如需詳細資訊，請參閱接下來的＜備註＞一節。

傳回值

如果函式成功，傳回值 會NERR_Success。

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

傳回碼	描述
ERROR_ACCESS_DENIED	使用者無法存取要求的資訊。
ERROR_INVALID_LEVEL	為 level 參數指定的值無效。
ERROR_INVALID_PARAMETER	指定的參數無效。如需詳細資訊，請參閱接下來的＜備註＞一節。
NERR_NetNameNotFound	共用名稱稱不存在。

備註

此函式僅適用于伺服器訊息區 (SMB) 共用。針對其他類型的共用，例如分散式檔案系統 (DFS) 或 WebDAV 共用，請使用支援所有類型的共用的 Windows 網路 (WNet) 函式。

只有 Administrators 或 Power Users 本機群組的成員，或具有 Print 或 Server Operator 群組成員資格的成員，才能成功執行 NetShareSetInfo 函式。列印操作員只能設定印表機共用的相關資訊。

如果 NetShareSetInfo 函式傳回 ERROR_INVALID_PARAMETER，您可以使用 parm_err 參數來指出共用資訊結構的第一個無效成員。 (共用資訊結構開頭為 SHARE_INFO_ ，而且其格式是由 level 參數所指定。) 下表列出可在 parm_err 參數中傳回的值，以及發生錯誤的對應結構成員。 (前置詞shi* 表示成員可以以多個前置詞開頭，例如 shi2 或shi502_.)

值	成員
SHARE_NETNAME_PARMNUM	*shi_netname**
SHARE_TYPE_PARMNUM	*shi_type**
SHARE_REMARK_PARMNUM	*shi_remark**
SHARE_PERMISSIONS_PARMNUM	*shi_permissions**
SHARE_MAX_USES_PARMNUM	*shi_max_uses**
SHARE_CURRENT_USES_PARMNUM	*shi_current_uses**
SHARE_PATH_PARMNUM	*shi_path**
SHARE_PASSWD_PARMNUM	*shi_passwd**
SHARE_FILE_SD_PARMNUM	*shi_security_descriptor**

如果您是針對 Active Directory 進行程式設計，您可以呼叫特定 Active Directory 服務介面 (ADSI) 方法來達成相同的功能，方法是呼叫網路管理共用函式。如需詳細資訊，請參閱 IADsFileShare。

如果為level參數指定 503，則SHARE_INFO_503結構shi503_servername成員中指定的遠端伺服器必須已使用NetServerTransportAddEx函式系結至傳輸通訊協定。在對 NetServerTransportAddEx的呼叫中，必須針對 level 參數指定 2 或 3，而且在傳輸通訊協定的 SERVER_TRANSPORT_INFO_2 結構中必須指定 SVTI2_SCOPED_NAME 旗標。

範例

下列程式碼範例示範如何使用 對 NetShareSetInfo 函式的呼叫，設定與共用資源相關聯的批註。若要這樣做，此範例會指定資訊層級 1004 (SHARE_INFO_1004) 。

#ifndef UNICODE
#define UNICODE
#endif
#include <windows.h>
#include <stdio.h>
#include <lm.h>
#pragma comment(lib, "Netapi32.lib")

void wmain( int argc, TCHAR *argv[ ])
{
   SHARE_INFO_1004 p;
   NET_API_STATUS res;
   DWORD parm_err = 0;

   if(argc<4)
      printf("Usage: SetInfo server share \"remark\"\n");
   else
   {
      //
      // Fill in SHARE_INFO_1004 structure member.
      //
      p.shi1004_remark=argv[3];
      //
      // Call the NetShareSetInfo function,
      //  specifying information level 1004.
      //
      res=NetShareSetInfo(argv[1], argv[2], 1004, (LPBYTE)&p, &parm_err);
      //
      // Display the result of the call.
      //
      if(res==0)
         printf("Remark set.\n");
      else
         printf("Error: %u\tparmerr=%u\n", res, parm_err);
   }
   return;
}

需求


最低支援的用戶端	Windows XP [僅限傳統型應用程式]
最低支援的伺服器	Windows Server 2003 [僅限傳統型應用程式]
目標平台	Windows
標頭	lmshare.h (包含 Lm.h)
程式庫	Netapi32.lib
Dll	Netapi32.dll