SetShareInfo method of the Win32_Share class

The SetShareInfoWMI class method sets the parameters of a shared resource.

This topic uses Managed Object Format (MOF) syntax. For more information about using this method, see Calling a Method.

Syntax


uint32 SetShareInfo(
  [in, optional] uint32                   MaximumAllowed,
  [in, optional] string                   Description,
  [in, optional] Win32_SecurityDescriptor Access
);

Parameters

MaximumAllowed [in, optional]

Limit on the maximum number of users allowed to use this resource concurrently.

Example: 10. This parameter is optional.

Description [in, optional]

Optional comment to describe the resource being shared.

Access [in, optional]

Security descriptor for user-level permissions. A security descriptor contains information about the permission, owner, and access capabilities of the resource. For more information, see Win32_SecurityDescriptor.

Return value

Returns one of the values listed in the following list or any other value to indicate an error.

Success (0)
Access denied (2)
Unknown failure (8)
Invalid name (9)
Invalid level (10)
Invalid parameter (21)
Duplicate share (22)
Redirected path (23)
Unknown device or directory (24)
Net name not found (25)
Other (26–4294967295)

Remarks

SetShareInfo method is a dynamic object method and is used on an occurrence of this class.

Only members of the Administrators or Account Operators local group or those with Communication, Print, or Server operator group membership can successfully execute SetShareInfo. The print operator can only set printer queues. The Communication operator can only set communication device queues.

Examples

The following PowerShell sample updates the name of the newShare share.


$newShare = Get-WmiObject win32_share | Where-Object {$_.name -eq "newShare"}
[void]$newShare.SetShareInfo($null,"This is my new description",$null)


Requirements

Minimum supported client

Windows Vista

Minimum supported server

Windows Server 2008

Namespace

Root\CIMV2

MOF

CIMWin32.mof

DLL

CIMWin32.dll

See also

Operating System Classes
Win32_Share

 

 

Show: