Skip to content

Latest commit

 

History

History
136 lines (104 loc) · 4.38 KB

nc-resapi-presource_type_control_routine.md

File metadata and controls

136 lines (104 loc) · 4.38 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NC:resapi.PRESOURCE_TYPE_CONTROL_ROUTINE
PRESOURCE_TYPE_CONTROL_ROUTINE (resapi.h)
Performs an operation that applies to a resource type.
PRESOURCE_TYPE_CONTROL_ROUTINE
PRESOURCE_TYPE_CONTROL_ROUTINE callback function [Failover Cluster]
ResourceTypeControl
ResourceTypeControl callback
ResourceTypeControl callback function [Failover Cluster]
_wolf_resourcetypecontrol
mscs.resourcetypecontrol
resapi/PRESOURCE_TYPE_CONTROL_ROUTINE
resapi/ResourceTypeControl
mscs\resourcetypecontrol.htm
MsCS
dc4a6e6e-f968-4502-88d0-dc692341528d
12/05/2018
PRESOURCE_TYPE_CONTROL_ROUTINE, PRESOURCE_TYPE_CONTROL_ROUTINE callback function [Failover Cluster], ResourceTypeControl, ResourceTypeControl callback, ResourceTypeControl callback function [Failover Cluster], _wolf_resourcetypecontrol, mscs.resourcetypecontrol, resapi/PRESOURCE_TYPE_CONTROL_ROUTINE, resapi/ResourceTypeControl
resapi.h
Windows
None supported
Windows Server 2008 Enterprise, Windows Server 2008 Datacenter
Windows
19H1
PRESOURCE_TYPE_CONTROL_ROUTINE
resapi/PRESOURCE_TYPE_CONTROL_ROUTINE
c++
APIRef
kbSyntax
UserDefined
ResApi.h
ResourceTypeControl

PRESOURCE_TYPE_CONTROL_ROUTINE callback function

-description

Performs an operation that applies to a resource type. The PRESOURCE_TYPE_CONTROL_ROUTINE type defines a pointer to this function.

-parameters

-param ResourceTypeName [in]

Type of resource to be affected by the operation.

-param ControlCode [in]

Control code that represents the operation to be performed. For a list of valid values for the ControlCode parameter, see Resource Type Control Codes.

-param InBuffer [in]

Pointer to a buffer containing data to be used in the operation. InBuffer can be NULL if the operation does not require data.

-param InBufferSize [in]

Size, in bytes, of the buffer pointed to by InBuffer.

-param OutBuffer [out]

Pointer to a buffer containing data resulting from the operation. OutBuffer can be NULL if the operation returns no data.

-param OutBufferSize [in]

Size, in bytes, of the available space pointed to by OutBuffer.

-param BytesReturned [out]

Number of bytes in the buffer pointed to by OutBuffer that actually contain data.

-returns

If the operation succeeds, the function returns ERROR_SUCCESS.

If the operation fails, the function returns a system error code. The following is a possible error code.

Return code Description
ERROR_INVALID_FUNCTION
The resource DLL requested that the Resource Monitor perform default processing (if any) for ControlCode in addition to processing supplied by the DLL (if any).

-remarks

Some control codes should be handled by the resource DLL, while others should be left to the Resource Monitor. For effective implementation strategies of the ResourceTypeControl entry-point function, see Implementing ResourceTypeControl.

Examples

See Resource DLL Examples.

-see-also

Resource DLL Entry-Point Functions