Edit

Share via

ResUtilSetPrivatePropertyList function (resapi.h)

  • Article

Sets the private properties of a cluster object.

Syntax

DWORD ResUtilSetPrivatePropertyList(
  [in] HKEY        hkeyClusterKey,
  [in] const PVOID pInPropertyList,
  [in] DWORD       cbInPropertyListSize
);

Parameters

[in] hkeyClusterKey

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

[in] pInPropertyList

Pointer to an input buffer containing a property list with the names and values of the properties to set.

[in] cbInPropertyListSize

Pointer to the size in bytes of the input buffer pointed to by pInPropertyList.

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_BAD_ARGUMENTS
 One or more of the input parameters were invalid.
ERROR_INVALID_DATA
 There was a problem with the length of a property's data.
ERROR_INSUFFICIENT_BUFFER
 The input buffer pointed to by pInPropertyList was NULL.
ERROR_INVALID_PARAMETER
 The syntax of a property name was invalid.

Remarks

The properties that are set in the ResUtilSetPrivatePropertyList utility function are placed in the portion of the cluster database below the specified key for the object exactly as specified by the names in the property list. If the name of a property contains backslash characters (\), each string preceding a backslash character is interpreted as a subkey name, and the last string following the last backslash character is interpreted as the value name.

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

ResUtilSetPrivatePropertyList 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

ResUtilVerifyPrivatePropertyList