Skip to content

Latest commit

 

History

History
89 lines (67 loc) · 2.58 KB

nf-propsys-pspropertybag_readint.md

File metadata and controls

89 lines (67 loc) · 2.58 KB
Raw
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:propsys.PSPropertyBag_ReadInt
PSPropertyBag_ReadInt function (propsys.h)
Reads an int data value from a property in a property bag.
PSPropertyBag_ReadInt
PSPropertyBag_ReadInt function [Windows Properties]
properties.PSPropertyBag_ReadInt
propsys/PSPropertyBag_ReadInt
shell.PSPropertyBag_ReadInt
shell_PSPropertyBag_ReadInt
properties\PSPropertyBag_ReadInt.htm
properties
9CEC97E6-C88F-4182-876C-D77EA14915DA
12/05/2018
PSPropertyBag_ReadInt, PSPropertyBag_ReadInt function [Windows Properties], properties.PSPropertyBag_ReadInt, propsys/PSPropertyBag_ReadInt, shell.PSPropertyBag_ReadInt, shell_PSPropertyBag_ReadInt
propsys.h
Windows
Windows 7 [desktop apps only]
Windows Server 2008 R2 [desktop apps only]
Propsys.lib
Propsys.dll (version 6.0 or later)
Windows
19H1
PSPropertyBag_ReadInt
propsys/PSPropertyBag_ReadInt
c++
APIRef
kbSyntax
DllExport
Propsys.dll
PSPropertyBag_ReadInt

PSPropertyBag_ReadInt function

-description

Reads an int data value from a property in a property bag.

-parameters

-param propBag [in]

Type: IPropertyBag*

A pointer to an IPropertyBag object that represents the property bag in which the property is stored.

-param propName [in]

Type: LPCWSTR

A null-terminated property name string.

-param value [out]

Type: int*

When this function returns, contains a pointer to an int property value.

-returns

Type: HRESULT

If this function succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

-remarks

If the property bag does not already contain the specified property, the call still succeeds.

The property bag property function API converts between window types and the VARIANT type that is used to express values in a property bag. Doing so eases property bag usage, simplifies applications, and avoids common coding errors.

-see-also

PSPropertyBag_WriteInt