Skip to content

Latest commit

 

History

History
169 lines (115 loc) · 4.96 KB

nc-resapi-poffline_v2_routine.md

File metadata and controls

169 lines (115 loc) · 4.96 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
NC:resapi.POFFLINE_V2_ROUTINE
POFFLINE_V2_ROUTINE (resapi.h)
The POFFLINE_V2_ROUTINE callback function marks a resource as unavailable for use after cleanup processing is complete.
CLUS_RESDLL_OFFLINE_DO_NOT_UPDATE_PERSISTENT_STATE
CLUS_RESDLL_OFFLINE_DUE_TO_EMBEDDED_FAILURE
CLUS_RESDLL_OFFLINE_IGNORE_NETWORK_CONNECTIVITY
CLUS_RESDLL_OFFLINE_IGNORE_RESOURCE_STATUS
CLUS_RESDLL_OFFLINE_QUEUE_ENABLED
CLUS_RESDLL_OFFLINE_RETURNING_TO_SOURCE_NODE_BECAUSE_OF_ERROR
CLUS_RESDLL_OFFLINE_RETURN_TO_SOURCE_NODE_ON_ERROR
OfflineV2
OfflineV2 callback
OfflineV2 callback function [Failover Cluster]
POFFLINE_V2_ROUTINE
POFFLINE_V2_ROUTINE callback function [Failover Cluster]
mscs.offlinev2
resapi/OfflineV2
resapi/POFFLINE_V2_ROUTINE
mscs\offlinev2.htm
MsCS
2983B328-08ED-4DA6-8DC2-79D44C710888
08/03/2022
CLUS_RESDLL_OFFLINE_DO_NOT_UPDATE_PERSISTENT_STATE, CLUS_RESDLL_OFFLINE_DUE_TO_EMBEDDED_FAILURE, CLUS_RESDLL_OFFLINE_IGNORE_NETWORK_CONNECTIVITY, CLUS_RESDLL_OFFLINE_IGNORE_RESOURCE_STATUS, CLUS_RESDLL_OFFLINE_QUEUE_ENABLED, CLUS_RESDLL_OFFLINE_RETURNING_TO_SOURCE_NODE_BECAUSE_OF_ERROR, CLUS_RESDLL_OFFLINE_RETURN_TO_SOURCE_NODE_ON_ERROR, OfflineV2, OfflineV2 callback, OfflineV2 callback function [Failover Cluster], POFFLINE_V2_ROUTINE, POFFLINE_V2_ROUTINE callback function [Failover Cluster], mscs.offlinev2, resapi/OfflineV2, resapi/POFFLINE_V2_ROUTINE
resapi.h
Windows
None supported
Windows Server 2012
Windows
19H1
POFFLINE_V2_ROUTINE
resapi/POFFLINE_V2_ROUTINE
c++
APIRef
kbSyntax
UserDefined
ResApi.h
OfflineV2

POFFLINE_V2_ROUTINE callback function

-description

Marks a resource as unavailable for use after cleanup processing is complete. The POFFLINE_V2_ROUTINE type defines a pointer to this function.

-parameters

-param Resource [in]

A resource identifier for the resource to be taken offline.

-param DestinationNodeName [in, optional]

The name of the node that is to contain the resource when the operation completes.

-param OfflineFlags [in]

A bitmask of flags that specify settings for this operation. This parameter can be set to one or more of the following values:

CLUS_RESDLL_OFFLINE_IGNORE_RESOURCE_STATUS (0x00000001)

Perform the operation even if the resource indicates that it should be locked.

CLUS_RESDLL_OFFLINE_RETURN_TO_SOURCE_NODE_ON_ERROR (0x00000002)

If the resource experiences an error, return it to the source node.

CLUS_RESDLL_OFFLINE_QUEUE_ENABLED (0x00000004)

Queue the operation if it is delayed by a resource DLL, and then retry the operation until it completes or is cancelled by the client.

CLUS_RESDLL_OFFLINE_RETURNING_TO_SOURCE_NODE_BECAUSE_OF_ERROR (0x00000008)

Indicate that the resource experienced an error, and is returning to the source node.

CLUS_RESDLL_OFFLINE_DUE_TO_EMBEDDED_FAILURE (0x00000010)

Indicate that there was an embedded failure.

CLUS_RESDLL_OFFLINE_IGNORE_NETWORK_CONNECTIVITY (0x00000020)

Perform the operation even if there is network error.

Windows Server 2012:  This value is not supported before Windows Server 2012 R2.

CLUS_RESDLL_OFFLINE_DO_NOT_UPDATE_PERSISTENT_STATE (0x00000040)

Do not update the persistent state of the resource.

Windows Server 2012 R2 and Windows Server 2012:  This value is not supported before Windows Server 2016.

-param InBuffer [in, optional]

A pointer to a buffer that contains data for the operation; otherwise NULL if the operation does not require data.

-param InBufferSize [in]

The size of the InBuffer parameter, in bytes.

-param Reserved [in]

Reserved.

-returns

Return code/value Description
ERROR_SUCCESS
0
The request completed successfully, and the resource is offline.
ERROR_IO_PENDING
997 (0x3E5)
The request is still pending, and a thread has been activated to process the offline request.
 

If the operation was not successful for other reasons, this function returns one of the system error codes.

-see-also

Resource DLL Entry Point Functions