RESOURCE_STATUS

The RESOURCE_STATUS structure contains information about a resource that is being brought online or taken offline. This structure is used as a parameter to the callback function SetResourceStatus. The RESOURCE_STATUS structure is defined in RESAPI.H.

typedef struct _RESOURCE_STATUS {
    CLUSTER_RESOURCE_STATE  ResourceState;
    DWORD                   CheckPoint;
    DWORD                   WaitHint;
    HANDLE                  EventHandle;
} RESOURCE_STATUS, *PRESOURCE_STATUS;
 

Members

ResourceState

A value describing the state of a resource. Valid values are:

ClusterResourceUnavailable

An error occurred trying to retrieve the state, typically because the server is no longer available. The caller should call the Win32 function GetLastError for more information.

ClusterResourceOnline

The resource is online and available.

ClusterResourceOffline

The resource is offline and unavailable.

ClusterResourceFailed

The resource has failed.

ClusterResourceOnlinePending

The resource is in the process of being placed online. The CheckPoint member should be greater than the previous value of this member.

ClusterResourceOfflinePending

The resource is in the process of being put offline.

CheckPoint

A value that increases sequentially by 1 whenever a new status is reported for the resource. The starting value for CheckPoint should be zero.

WaitHint

The number of milliseconds expected until the next time that status is reported.

EventHandle

Handle to an event that indicates when the resource has failed.

Remarks

Resource DLLs typically set the ResourceState member to ClusterResourceOnline or ClusterResourceOffline. However, if ResourceState is set to ClusterResourceOnlinePending or ClusterResourceOfflinePending, then the CheckPoint member should be greater than the previous value reported for CheckPoint.

Before returning the ClusterResourceUnavailable state in the ResourceState member, a resource DLL should call the Win32 function SetLastError.

Resource DLLs set the EventHandle member to a handle that is signaled when a resource fails.

QuickInfo

  Version: Use Windows NT Server Enterprise Edition 4.0.
  Windows CE: Unsupported.
  Header: Declared in resapi.h.