CLUSCTL_RESOURCE_FILESERVER_SHARE_DEL control code

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

Deletes a 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_DEL, // control code
                        lpInBuffer,                            // input buffer: file share name
                        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 the name of the file share resource to be deleted.

Return value

ClusterResourceControl returns one of the following values.

ERROR_SUCCESS

0

The operation was successful. The file share has been deleted.

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_DEL (0x01400249) as follows.

ComponentBit locationValue
Object code24–31CLUS_OBJECT_RESOURCE (0x1)
Global bit23CLUS_NOT_GLOBAL (0x0)
Modify bit22CLUS_MODIFY (0x1)
User bit21CLCTL_CLUSTER_BASE (0x0)
Type bit20External (0x0)
Operation code0–23CLCTL_FILESERVER_SHARE_DEL (0x400249)
Access code0–1CLUS_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
Cluster Control Codes
ClusterResourceControl

 

 

Show: