Skip to content

Latest commit

 

History

History
122 lines (94 loc) · 3.75 KB

nf-clusapi-offlineclusterresource.md

File metadata and controls

122 lines (94 loc) · 3.75 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:clusapi.OfflineClusterResource
OfflineClusterResource function (clusapi.h)
Takes a resource offline.
OfflineClusterResource
OfflineClusterResource function [Failover Cluster]
PCLUSAPI_OFFLINE_CLUSTER_RESOURCE
PCLUSAPI_OFFLINE_CLUSTER_RESOURCE function [Failover Cluster]
_wolf_offlineclusterresource
clusapi/OfflineClusterResource
clusapi/PCLUSAPI_OFFLINE_CLUSTER_RESOURCE
mscs.offlineclusterresource
mscs\offlineclusterresource.htm
MsCS
694dbf3d-3355-44d9-8af0-ea2baae832fd
12/05/2018
OfflineClusterResource, OfflineClusterResource function [Failover Cluster], PCLUSAPI_OFFLINE_CLUSTER_RESOURCE, PCLUSAPI_OFFLINE_CLUSTER_RESOURCE function [Failover Cluster], _wolf_offlineclusterresource, clusapi/OfflineClusterResource, clusapi/PCLUSAPI_OFFLINE_CLUSTER_RESOURCE, mscs.offlineclusterresource
clusapi.h
Windows
None supported
Windows Server 2008 Enterprise, Windows Server 2008 Datacenter
ClusAPI.lib
ClusAPI.dll
Windows
19H1
OfflineClusterResource
clusapi/OfflineClusterResource
c++
APIRef
kbSyntax
DllExport
ClusAPI.dll
Ext-MS-Win-Cluster-ClusAPI-L1-1-2.dll
ext-ms-win-cluster-clusapi-l1-1-3.dll
OfflineClusterResource

OfflineClusterResource function

-description

Takes a resource offline. The PCLUSAPI_OFFLINE_CLUSTER_RESOURCE type defines a pointer to this function.

-parameters

-param hResource [in]

Handle to the resource to be taken offline.

-returns

If the operation succeeds, the function returns ERROR_SUCCESS.

If the operation fails, the function returns one of the following system error codes.

Return code Description
ERROR_IO_PENDING
The resource or one of the resources it depends on has returned ERROR_IO_PENDING from its Offline entry point function.
ERROR_RESOURCE_FAILED
This system error code is not returned.

Windows Server 2008 Datacenter and Windows Server 2008 Enterprise:  The function attempted to take offline a failed resource, so the failed resource has not been transitioned to an offline state.

-remarks

When calling OfflineClusterResource to offline a failed resource, it returns ERROR_SUCCESS instead of ERROR_RESOURCE_FAILED, and the resource will transition to the offline state.

Do not call OfflineClusterResource from a resource DLL. For more information, see Function Calls to Avoid in Resource DLLs.

-see-also

Offline

Online

OnlineClusterResource

OpenClusterResource