Share via


CLUSCTL_RESOURCE_STORAGE_GET_MOUNTPOINTS control code

Retrieves a list of path names for the specified partition. Applications use this control code as a parameter to the ClusterResourceControl function, and resource DLLs receive the control code as a parameter to the ResourceControl function.

ClusterResourceControl( hResource,                                // resource handle
                        hHostNode,                                // optional host node
                        CLUSCTL_RESOURCE_STORAGE_GET_MOUNTPOINTS, // dwControlCode
                        lpInBuffer,                               // pointer to a DWORD
                        cbInBufferSize,                           // input buffer size (bytes)
                        lpOutBuffer,                              // output buffer: path names
                        cbOutBufferSize,                          // output buffer size (bytes)
                        lpcbBytesReturned );                      // size of output data (bytes)

Parameters

The following control code function and DLL support parameters are specific to this control code. For complete parameter descriptions, see ClusterResourceControl or ResourceControl.

lpInBuffer [in]

Pointer to a DWORD specifying the partition number.

cbInBufferSize [in]

The size (in bytes) of the input buffer. This must be at least sizeof(DWORD).

lpOutBuffer [out]

On a successful return, points to a list of path names for the specified volume. For more information, see GetVolumePathNamesForVolumeName.

cbOutBufferSize [in]

The allocated size (in bytes) of the output buffer.

lpBytesReturned [out, optional]

Returns the actual size (in bytes) of the data resulting from the operation. If this information is not needed, pass NULL for lpBytesReturned.

Return value

ClusterResourceControl returns one of the following values:

ERROR_SUCCESS

0

The operation was successful. 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.

System error code

The operation failed. The value of lpcbBytesReturned is unreliable.

Implementations of ResourceControl can return the above values or the following value:

ERROR_INVALID_FUNCTION

1

Requests that the Resource Monitor perform default processing (if any) for the control code addition to processing supplied by the DLL (if any).

Remarks

Do not use the CLUSCTL_RESOURCE_STORAGE_GET_MOUNTPOINTS control code in any resource DLL entry point function. This control code can safely be called from a worker thread. For more information, see Function Calls to Avoid in Resource DLLs.

ClusAPI.h defines the 32 bits of CLUSCTL_RESOURCE_STORAGE_GET_MOUNTPOINTS 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_NO_MODIFY (0x0)
User bit
21
CLCTL_CLUSTER_BASE (0x0)
Type bit
20
External (0x0)
Operation code
0 23
CLCTL_STORAGE_GET_MOUNTPOINTS (0x211)
Access code
0 1
CLUS_ACCESS_READ (0x1)

For more information, see Control Code Architecture.

Resource DLL Support

Conditional. You must support the CLUSCTL_RESOURCE_STORAGE_GET_MOUNTPOINTS control code if your resource DLL handles storage class resources such as quorum-capable resources. Return a value list that fully describes the storage class resource. For information on working with value lists, see Using Value Lists.

The Resource Monitor does not provide default handling.

For more information on the ResourceControl entry point function, see Implementing ResourceControl.

Requirements

Minimum supported client
None supported
Minimum supported server
Windows Server 2008 Datacenter, Windows Server 2008 Enterprise
Header
ClusAPI.h

See also

ClusterResourceControl

ResourceControl

GetVolumePathNamesForVolumeName