PONLINE_V2_ROUTINE callback function (resapi.h)

Marks a resource as available for use. The PONLINE_V2_ROUTINE type defines a pointer to this function.

Syntax

PONLINE_V2_ROUTINE PonlineV2Routine;

DWORD PonlineV2Routine(
  [in]           RESID Resource,
  [out]          LPHANDLE EventHandle,
  [in]           DWORD OnlineFlags,
  [in, optional] PBYTE InBuffer,
  [in]           DWORD InBufferSize,
  [in]           DWORD Reserved
)
{...}

Parameters

[in] Resource

A resource identifier for the resource to be made available.

[out] EventHandle

On input, EventHandle is NULL. On output, EventHandle contains a handle to a non signaled synchronization object. The resource DLL can signal this handle at any time to report a resource failure to the Resource Monitor. EventHandle can also be set to NULL on output, which indicates that the resource does not support asynchronous event notifications.

[in] OnlineFlags

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_ONLINE_RECOVER_MONITOR_STATE (0x00000001)

Monitor the state of the resource if the resource is recovering from an error.

CLUS_RESDLL_ONLINE_IGNORE_RESOURCE_STATUS (0x00000002)

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

CLUS_RESDLL_ONLINE_RETURN_TO_SOURCE_NODE_ON_ERROR (0x00000004)

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

CLUS_RESDLL_ONLINE_RESTORE_ONLINE_STATE (0x00000008)

Set the status of the resource to online.

CLUS_RESDLL_ONLINE_IGNORE_NETWORK_CONNECTIVITY (0x00000010)

Perform the operation even if there is network error.

[in, optional] InBuffer

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

[in] InBufferSize

The size of the InBuffer parameter, in bytes.

[in] Reserved

Reserved.

Return value

If the operation was not successful for other reasons, a system error code is returned.

Requirements

See also

Resource DLL Entry-Point Functions