ResUtilSetPrivatePropertyList function

Sets the private properties of a cluster object.

Syntax


DWORD WINAPI ResUtilSetPrivatePropertyList(
  _In_       HKEY  hkeyClusterKey,
  _In_ const PVOID pInPropertyList,
  _In_       DWORD cbInPropertyListSize
);

typedef DWORD (WINAPI *PRESUTIL_SET_PRIVATE_PROPERTY_LIST)(
    _In_       HKEY  hkeyClusterKey,
    _In_ const PVOID pInPropertyList,
    _In_       DWORD cbInPropertyListSize
);

Parameters

hkeyClusterKey [in]

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

pInPropertyList [in]

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

cbInPropertyListSize [in]

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.

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

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

ResUtilVerifyPrivatePropertyList

 

 

Show: