CLUSCTL_RESOURCE_FILESERVER_SHARE_REPORT control code
[The CLUSCTL_RESOURCE_FILESERVER_SHARE_REPORT control code is available for use in the operating systems specified in the Requirements section. It may be altered or unavailable in subsequent versions.]
Retrieves the add/delete/change notifications for file shares managed by the File Server 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_REPORT, // control code
lpInBuffer, // input buffer (not used)
nInBufferSize, // input buffer size (not used)
lpOutBuffer, // output buffer notification list
cbOutBufferSize, // output buffer size (bytes)
lpcbBytesReturned ); // returned data size (bytes)
Parameters
The following control code function parameter is specific to this control code. For complete parameter descriptions, see ClusterResourceControl.
-
lpOutBuffer
-
On a successful return, points to a notification list containing the resource's add/delete/change notifications.
Return value
ClusterResourceControl returns one of the following values.
-
ERROR_SUCCESS
-
0
The operation completed successfully. The lpcbBytesReturned parameter points to the actual size of the returned data.
-
ERROR_MORE_DATA
-
234 (0xEA)
The output buffer pointed to by lpOutBuffer was not large enough to hold the data resulting from the operation. The lpcbBytesReturned parameter points to the size required for the output buffer.
-
If any other value is returned, then the operation failed. The value of lpcbBytesReturned is unreliable.
Remarks
The structure for the notification list comes from the FILESHARE_CHANGE_LIST structure.
ClusAPI.h defines the 32 bits of CLUSCTL_RESOURCE_FILESERVER_SHARE_REPORT (0x01400251) 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_REPORT (0x400251) |
| 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 |