CLRES_V1_FUNCTION_TABLE macro (resapi.h)

Article
02/22/2024

Initializes a function table for version 1.0 of the Resource API.

Syntax

void CLRES_V1_FUNCTION_TABLE(
   _Name,
   _Version,
   _Prefix,
   _Arbitrate,
   _Release,
   _ResControl,
   _ResTypeControl
);

Parameters

_Name

Label for the function table.

_Version

Defines the exact version, such as CLRES_VERSION_V1_00.

_Prefix

Prefix to be appended to the front of each of the names of the entry points in the function table.

_Arbitrate

Name of the Arbitrate entry point.

_Release

Name of the Release entry point.

_ResControl

Name of the ResourceControl entry point.

_ResTypeControl

Name of the ResourceTypeControl entry point.

Return value

None

Remarks

The CLRES_V1_FUNCTION_TABLE macro creates a function table for version 1.0 of the Resource API using the version specified by the Version parameter and the label specified by the Name parameter. The actual names of the entry points are generated by combining the prefix specified in the Prefix parameter with the generic names as defined in the Resource API. For example, if Prefix is set to the string "FileShare", then the name of the Open function would be "FileShareOpen". Notice that the optional entry point functions may be NULL.

The resulting function table includes the following members.

Member	Description
Prefix	Name of the Open entry point.
Prefix	Name of the Close entry point.
Prefix	Name of the Online entry point.
Prefix	Name of the Offline entry point.
Prefix	Name of the Terminate entry point.
Prefix	Name of the LooksAlive entry point.
Prefix	Name of the IsAlive entry point.

To view the format of the function table, see the CLRES_FUNCTION_TABLE structure.

Examples

See Defining Structures and Constants in Implementing Resource DLLs.

Requirements

Requirement	Value
Minimum supported client	None supported
Minimum supported server	Windows Server 2008 Enterprise, Windows Server 2008 Datacenter
Target Platform	Windows
Header	resapi.h