ResUtilGetPropertiesToParameterBlock
The ResUtilGetPropertiesToParameterBlock utility function returns properties and stores them in a parameter block.
DWORD WINAPI ResUtilGetPropertiesToParameterBlock(
PVOID ClusterKey,
const PRESUTIL_PROPERTY_ITEM PropertyTable,
LPBYTES OutParams,
BOOL CheckForRequiredProperties,
LPWSTR *NameOfPropInError
);
Parameters
-
ClusterKey
-
[in] Pointer to the cluster database key that identifies the location of the properties to retrieve.
-
PropertyTable
-
[in] Pointer to an array of RESUTIL_PROPERTY_ITEM structures that describes the properties to process.
-
OutParams
-
[out] Pointer to the output parameter block to fill.
-
CheckForRequiredProperties
-
[in] Specifies whether or not an error should be generated if required properties are missing.
-
NameOfPropInError
-
[out] Address of the string pointer in which to return the name of the error generated by a missing required property. The NameOfPropInError property is optional.
Return Values
-
ERROR_SUCCESS
-
Properties were successfully stored in the parameter block.
-
ERROR_BAD_ARGUMENTS
-
One or more of the input parameters were invalid.
-
ERROR_NOT_ENOUGH_MEMORY
-
There was an error allocating memory.
If the operation was unsuccessful, ResUtilGetPropertiesToParameterBlock can also return a Win32® error value.
Notes to Callers
The property table pointed to by PropertyTable can include default values.
QuickInfo
Version: Use Windows NT Server Enterprise Edition 4.0.
Windows CE: Unsupported.
Header: Declared in clusapi.h.