ResUtilSetPropertyParameterBlockEx function

Sets properties in the cluster database from a parameter block.

Syntax


DWORD WINAPI ResUtilSetPropertyParameterBlockEx(
  _In_            HKEY                   hkeyClusterKey,
  _In_      const PRESUTIL_PROPERTY_ITEM pPropertyTable,
  _In_            PVOID                  Reserved,
  _In_      const LPBYTE                 pInParams,
  _In_      const PVOID                  pInPropertyList,
  _In_            DWORD                  cbInPropertyListSize,
  _In_            BOOL                   bForceWrite,
  _Out_opt_       LPBYTE                 pOutParams
);

typedef DWORD (WINAPI *PRESUTIL_SET_PROPERTY_PARAMETER_BLOCK_EX)(
    _In_            HKEY                   hkeyClusterKey,
    _In_      const PRESUTIL_PROPERTY_ITEM pPropertyTable,
    _In_            PVOID                  Reserved,
    _In_      const LPBYTE                 pInParams,
    _In_      const PVOID                  pInPropertyList,
    _In_            DWORD                  cbInPropertyListSize,
    _In_            BOOL                   bForceWrite,
    _Out_opt_       LPBYTE                 pOutParams
);

Parameters

hkeyClusterKey [in]

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

pPropertyTable [in]

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

Reserved [in]

Reserved.

pInParams [in]

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

pInPropertyList [in]

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.

cbInPropertyListSize [in]

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

bForceWrite [in]

Forces the property values to be written to the cluster database even if the new values are identical to the existing values

pOutParams [out, optional]

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.

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

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

ResUtilSetPropertyParameterBlockEx 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

Minimum supported client

None supported

Minimum supported server

Windows Server 2008 Enterprise, Windows Server 2008 Datacenter

Header

ResApi.h

Library

ResUtils.lib

DLL

ResUtils.dll

See also

RESUTIL_PROPERTY_ITEM
ResUtilSetPropertyParameterBlock

 

 

Show: