Skip to content

Latest commit

 

History

History
120 lines (89 loc) · 4.97 KB

nf-resapi-resutiladdunknownproperties.md

File metadata and controls

120 lines (89 loc) · 4.97 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:resapi.ResUtilAddUnknownProperties
ResUtilAddUnknownProperties function (resapi.h)
Retrieves a set of unknown properties from the cluster database and appends them to the end of a property list.
PRESUTIL_ADD_UNKNOWN_PROPERTIES
PRESUTIL_ADD_UNKNOWN_PROPERTIES function [Failover Cluster]
ResUtilAddUnknownProperties
ResUtilAddUnknownProperties function [Failover Cluster]
_wolf_resutiladdunknownproperties
mscs.resutiladdunknownproperties
resapi/PRESUTIL_ADD_UNKNOWN_PROPERTIES
resapi/ResUtilAddUnknownProperties
mscs\resutiladdunknownproperties.htm
MsCS
17659c86-d7cc-4316-ba0e-ce71de727fa1
12/05/2018
PRESUTIL_ADD_UNKNOWN_PROPERTIES, PRESUTIL_ADD_UNKNOWN_PROPERTIES function [Failover Cluster], ResUtilAddUnknownProperties, ResUtilAddUnknownProperties function [Failover Cluster], _wolf_resutiladdunknownproperties, mscs.resutiladdunknownproperties, resapi/PRESUTIL_ADD_UNKNOWN_PROPERTIES, resapi/ResUtilAddUnknownProperties
resapi.h
Windows
None supported
Windows Server 2008 Enterprise, Windows Server 2008 Datacenter
ResUtils.lib
ResUtils.dll
Windows
19H1
ResUtilAddUnknownProperties
resapi/ResUtilAddUnknownProperties
c++
APIRef
kbSyntax
DllExport
ResUtils.dll
ResUtilAddUnknownProperties

ResUtilAddUnknownProperties function

-description

Retrieves a set of unknown properties from the cluster database and appends them to the end of a property list.

-parameters

-param hkeyClusterKey [in]

Pointer to the cluster database key that identifies the location for the properties to read.

-param pPropertyTable [in]

Pointer to a property table describing the common and private properties of an object. Any properties found in the cluster database that are not in this property table are added to the property list.

-param pOutPropertyList [in, out]

Pointer to a buffer in which to receive the returned properties. On input, the buffer can contain an existing property list, or it can be empty. On output, the retrieved properties will be appended to the end of the existing list, or, if the buffer is empty, will return as a new property list.

-param pcbOutPropertyListSize [in]

Total byte size of the buffer pointed to by pOutPropertyList. The size of the buffer must be large enough to contain the existing property list and the property list to be returned.

-param pcbBytesReturned [in, out]

On input, pointer to the byte size of the property list contained by the pOutPropertyList buffer. On output, pointer to the total number of bytes in the property list pointed to by pOutPropertyList.

-param pcbRequired [in, out]

On output, points to the total number of bytes required to hold the returned property list. If the pOutPropertyList buffer was too small, it can be reallocated to the required size.

-returns

If the operation succeeds, the function returns ERROR_SUCCESS.

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

Return code Description
ERROR_NOT_ENOUGH_MEMORY
There was an error allocating memory.

-remarks

The relationships between the input and output parameters of ResUtilAddUnknownProperties are illustrated in the following diagram:

:::image type="content" source="./images/resutil.png" border="false" alt-text="Diagram showing input and output parameters listed separately in two buffers. Two unknown properties have been added to the output parameter list.":::

The ResUtilAddUnknownProperties utility function enumerates the properties stored in the cluster database (under hkeyClusterKey) and looks for corresponding properties in the property table (pPropertyTable). Each property that is listed in the cluster database but not listed in the property table is added to the property list (pOutPropertyList).

-see-also

RESUTIL_PROPERTY_ITEM

ResUtilSetUnknownProperties