3.1.4.1.17 ApiFailResource (Opnum 16)

  • Article

(Protocol Version 2) The ApiFailResource method instructs the cluster to treat the designated resource as having failed the criteria that determine whether the resource is functioning correctly. The cluster MAY choose to call recovery methods as specified in section 3.1.1.1.1.

The server MUST accept an ApiFailResource request for processing only if it is in the read/write state, as specified in section 3.1.1.

 error_status_t ApiFailResource(
   [in] HRES_RPC hResource
 );

hResource: An HRES_RPC context handle that was obtained in a previous ApiOpenResource or ApiCreateResource method call.

Return Values: The method MUST return the following error codes for the specified conditions.

Return value/code

Description

0x00000000

ERROR_SUCCESS

Success.

0x00000006

ERROR_INVALID_HANDLE

The data that is pointed to by the hResource parameter does not represent a valid HRES_RPC context handle.

0x0000138E

ERROR_RESOURCE_NOT_AVAILABLE

The resource represented by the hResource parameter no longer exists in the nonvolatile cluster state.

0x000013DC

ERROR_RESMON_INVALID_STATE

The resource is not in the ClusterResourceOnline state.

For any other condition, the server MUST set Status to a value that is not one of the values listed in the preceding table. The client MUST treat all values not listed in the preceding table the same, except as specified in section 3.2.4.6.