ResUtilSetPropertyParameterBlock function (resapi.h)

  • Article

Sets properties in the cluster database from a parameter block.

Syntax

DWORD ResUtilSetPropertyParameterBlock(
  [in]            HKEY                         hkeyClusterKey,
  [in]            const PRESUTIL_PROPERTY_ITEM pPropertyTable,
  [in]            PVOID                        Reserved,
  [in]            const LPBYTE                 pInParams,
  [in]            const PVOID                  pInPropertyList,
  [in]            DWORD                        cbInPropertyListSize,
  [out, optional] LPBYTE                       pOutParams
);

Parameters

[in] hkeyClusterKey

Cluster database key identifying the location for the properties to set.

[in] pPropertyTable

Pointer to an array of RESUTIL_PROPERTY_ITEM structures describing the properties to set.

[in] Reserved

Reserved.

[in] pInParams

Pointer to an input parameter block containing the data for the properties described in the property table pointed to by pPropertyTable.

[in] pInPropertyList

Pointer to the input buffer containing a property list or NULL. If pInPropertyList is not NULL, any properties listed in the property list that are not listed in the property table are also set in the cluster database.

[in] cbInPropertyListSize

Size in bytes of the input buffer pointed to by pInPropertyList.

[out, optional] pOutParams

Pointer to a parameter block to receive data copied from the pInParams parameter.

Return value

If the operation succeeds, the function returns ERROR_SUCCESS.

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

Return code Description
ERROR_INVALID_PARAMETER
 The syntax, format, or type of a property in the property table pointed to by pPropertyTable is incorrect, or a property is read-only and cannot be updated.
ERROR_BAD_ARGUMENTS
 One or more of the input parameters were invalid.

Remarks

If a value specified in the parameter block already exists in the cluster database, the value is not written. To force all values to be written, see ResUtilSetPropertyParameterBlockEx.

Do not call ResUtilSetPropertyParameterBlock from the following resource DLL entry point functions:

ResUtilSetPropertyParameterBlock can be safely called from any other resource DLL entry point function or from a worker thread. For more information, see Function Calls to Avoid in 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
Library ResUtils.lib
DLL ResUtils.dll

See also

RESUTIL_PROPERTY_ITEM