Windows Dev Center

EN
Dieser Inhalt ist in Ihrer Sprache leider nicht verfügbar. Im Folgenden finden Sie die englische Version.

PSPropertyBag_ReadStr function

Reads the string data value of a property in a property bag.

Syntax


HRESULT PSPropertyBag_ReadStr(
  _In_  IPropertyBag *propBag,
  _In_  LPCWSTR      propName,
  _Out_ LPCWSTR      value,
  _Out_ int          characterCount
);

Parameters

propBag [in]

Type: IPropertyBag*

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

propName [in]

Type: LPCWSTR

A null-terminated property name string.

value [out]

Type: LPCWSTR

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

characterCount [out]

Type: int

This function returns the integer that represents the size (maximum number of characters) of the value parameter being returned.

Return value

Type: HRESULT

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

Remarks

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.

Requirements

Minimum supported client

Windows 7 [desktop apps only]

Minimum supported server

Windows Server 2008 R2 [desktop apps only]

Header

Propsys.h

Library

Propsys.lib

DLL

Propsys.dll (version 6.0 or later)

See also

PSPropertyBag_WriteStr

 

 

Community-Beiträge

HINZUFÜGEN
Anzeigen:
© 2015 Microsoft