ResUtilGetPropertiesToParameterBlock function (resapi.h)

Retrieves properties specified by a property table from the cluster database and returns them in a parameter block.

Syntax

DWORD ResUtilGetPropertiesToParameterBlock(
  [in]            HKEY                         hkeyClusterKey,
  [in]            const PRESUTIL_PROPERTY_ITEM pPropertyTable,
  [out]           LPBYTE                       pOutParams,
  [in]            BOOL                         bCheckForRequiredProperties,
  [out, optional] LPWSTR                       *pszNameOfPropInError
);

Parameters

[in] hkeyClusterKey

Pointer to the cluster database key that identifies the location of the properties to retrieve.

[in] pPropertyTable

Pointer to an array of RESUTIL_PROPERTY_ITEM structures that describes the properties to process.

[out] pOutParams

Pointer to the output parameter block to fill.

[in] bCheckForRequiredProperties

Specifies whether an error should be generated if required properties are missing.

[out, optional] pszNameOfPropInError

Address of the string pointer in which to return the name of the error generated by a missing required property. The ppszNameOfPropInError property is optional.

Return value

If the operations succeeds, the function returns ERROR_SUCCESS.

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

Remarks

With the ResUtilGetPropertiesToParameterBlock utility function, the property table pointed to by pPropertyTable can include default values.

Requirements

See also

RESUTIL_PROPERTY_ITEM