3.1.4.2.17 ApiFailResource (Opnum 16)

(Protocol Version 3) 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.

The server MUST require that the access level associated with the hResource context handle is "All" (section 3.1.4).

 error_status_t ApiFailResource(
   [in] HRES_RPC hResource,
   [out] error_status_t *rpc_status
 );

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

rpc_status: A 32-bit integer used to indicate success or failure. The RPC runtime MUST indicate, by writing to this parameter, whether it succeeded in executing this method on the server. The encoding of the value passed in this parameter MUST conform to encoding for  comm_status and fault_status, as specified in Appendix E of [C706].

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.
0x0000139F ERROR_INVALID_STATE	The resource is not in the ClusterResourceOnline, ClusterResourceOnlinePending, or ClusterResourceOfflinePending states.

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.