PSET_RESOURCE_STATUS_ROUTINE callback function (resapi.h)

Article
08/23/2022

Called to update the status of a resource. The PSET_RESOURCE_STATUS_ROUTINE type defines a pointer to this function.

Syntax

PSET_RESOURCE_STATUS_ROUTINE PsetResourceStatusRoutine;

DWORD PsetResourceStatusRoutine(
  [in] RESOURCE_HANDLE ResourceHandle,
  [in] PRESOURCE_STATUS ResourceStatus
)
{...}

Parameters

[in] ResourceHandle

Handle identifying the resource to be updated. The ResourceHandle parameter should contain the same handle used for the ResourceHandle parameter in the Open entry point for this resource.

[in] ResourceStatus

Pointer to a RESOURCE_STATUS structure that contains information about the resource's state.

Return value

SetResourceStatus returns one of the following values enumerated from the RESOURCE_EXIT_STATE enumeration.

Return code/value	Description
ResourceExitStateContinue 0	The resource has not been terminated. Worker threads may continue Online and Offline operations for the resource.
ResourceExitStateTerminate 1	The resource has been terminated. Callers should end Online or Offline operations and immediately terminate all worker threads assigned to the resource.

Remarks

Resource DLLs call the SetResourceStatus callback function to update the status of a resource after their Online or Offline entry point function has returned ERROR_IO_PENDING. It should not be called at any other time. A pointer to the SetResourceStatus function is passed in the SetResourceStatus parameter to the resource's implementation of Startup.

SetResourceStatus is implemented by the Resource Monitor and is similar to the SetServiceStatus function.

Update the current state of a resource whenever necessary after you have returned ERROR_IO_PENDING. If the resource is in one of the pending states, increment the values for the CheckPoint and WaitHint members of the RESOURCE_STATUS structure and set the ResourceState member to ClusterResourceOnlinePending or ClusterResourceOfflinePending before you begin calling SetResourceStatus. Call SetResourceStatus until one of the following situations occurs:

The resource is placed in either the ClusterResourceOnline or ClusterResourceOffline state.
The time limit stored in the resource's PendingTimeout property has been exceeded.

There is no need to call SetResourceStatus to set the state of a resource to a pending state because the Resource Monitor automatically sets it to the appropriate pending state whenever Online or Offline returns ERROR_IO_PENDING.

Requirements

Requirement	Value
Minimum supported client	None supported
Minimum supported server	Windows Server 2008 Enterprise, Windows Server 2008 Datacenter
Target Platform	Windows
Header	resapi.h