CM_Free_Res_Des_Handle function (cfgmgr32.h)

The CM_Free_Res_Des_Handle function invalidates a resource description handle and frees its associated memory allocation.

Syntax

CMAPI CONFIGRET CM_Free_Res_Des_Handle(
  [in] RES_DES rdResDes
);

Parameters

[in] rdResDes

Caller-supplied resource descriptor handle to be freed. This handle must have been previously obtained by calling one of the following functions:

CM_Add_Res_Des

CM_Add_Res_Des_Ex

CM_Get_Next_Res_Des

CM_Get_Next_Res_Des_Ex

CM_Modify_Res_Des

CM_Modify_Res_Des_Ex

Return value

If the operation succeeds, the function returns CR_SUCCESS. Otherwise, it returns one of the CR_-prefixed error codes defined in Cfgmgr32.h.

Remarks

Each time your code calls one of the functions listed under the description of rdResDes, it must subsequently call CM_Free_Res_Des_Handle.

Requirements