CLUSCTL_RESOURCE_FILESERVER_SHARE_MODIFY control code

[The CLUSCTL_RESOURCE_FILESERVER_SHARE_MODIFY control code is available for use in the operating systems specified in the Requirements section. It may be altered or unavailable in subsequent versions.]

Modifies an existing file share on a physical disk resource. Applications use this control code as a parameter to the ClusterResourceControl function.

ClusterResourceControl( hResource,                                // cluster handle
                        hHostNode,                                // optional node handle
                        CLUSCTL_RESOURCE_FILESERVER_SHARE_MODIFY, // this control code
                        lpInBuffer,                               // input buffer: property list
                        nInBufferSize,                            // input buffer size
                        lpOutBuffer,                              // output buffer (not used)
                        cbOutBufferSize,                          // output buffer size (not used)
                        lpcbBytesReturned );                      // returned data size (not used)

Parameters

The following control code function parameter is specific to this control code. For complete parameter descriptions, see ClusterResourceControl.

lpInBuffer

Points to a property list containing the changes for the file share resource's properties.

Return value

ClusterResourceControl returns one of the following values.

ERROR_SUCCESS

0

The operation completed successfully. The file share has been modified.

System error code

If any other value is returned, then the operation failed.

Remarks

ClusAPI.h defines the 32 bits of CLUSCTL_RESOURCE_FILESERVER_SHARE_MODIFY (0x0140024d) as follows:

Component	Bit location	Value
Object code	24 31	CLUS_OBJECT_RESOURCE (0x1)
Global bit	23	CLUS_NOT_GLOBAL (0x0)
Modify bit	22	CLUS_MODIFY (0x1)
User bit	21	CLCTL_CLUSTER_BASE (0x0)
Type bit	20	External (0x0)
Operation code	0 23	CLCTL_FILESERVER_SHARE_MODIFY (0x40024d)
Access code	0 1	CLUS_ACCESS_READ (0x1)

For more information, see Control Code Architecture.

Requirements

Minimum supported client	None supported
Minimum supported server	Windows Server 2008 Datacenter, Windows Server 2008 Enterprise
End of client support	None supported
End of server support	Windows Server 2008 R2 Datacenter, Windows Server 2008 R2 Enterprise

See also

External Resource Control Codes

ClusterResourceControl