IVsPropertyStreamIn.Read Method

Definition

Reads a property and value from the stream.

C++/WinRT
int Read(unsigned int cchPropertyName, std::Array <unsigned short> const & szPropertyName, [Runtime::InteropServices::Out] unsigned int & pcchPropertyNameActual, std::Array <Microsoft::VisualStudio::Shell::Interop::VSPROPERTYSTREAMPROPERTYTYPE> const & pvspspt, [Runtime::InteropServices::Out] winrt::Windows::Foundation::IInspectable const & & pvarValue, Microsoft::VisualStudio::OLE::Interop::IErrorLog const & pIErrorLog);

Parameters

cchPropertyName
UInt32

[in] Length of szPropertyName.

szPropertyName
UInt16[]

[out] String containing the property name.

pcchPropertyNameActual
UInt32

[out] Length of property name.

pvspspt
VSPROPERTYSTREAMPROPERTYTYPE[]

[out] Pointer to a value from the VSPROPERTYSTREAMPROPERTYTYPE enumeration indicating whether this is a simple property or a substream of the property stream.

pvarValue
Object

[out] A VARIANT containing the property value.

pIErrorLog
IErrorLog

[in] The IErrorLog interface to use for reporting errors.

Returns

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

COM Signature

From vsshell.idl:

[C++]

HRESULT IVsPropertyStreamIn::Read(  
   [in] ULONG cchPropertyName,   
   [in, out, size_is(cchPropertyName)] OLECHAR szPropertyName[],   
   [out] ULONG *pcchPropertyNameActual,   
   [out] VSPROPERTYSTREAMPROPERTYTYPE *pvspspt,   
   [out] VARIANT *pvarValue, [in] IErrorLog *pIErrorLog  
);  

Applies to

Proizvod Verzije
Visual Studio SDK 2015, 2017, 2019, 2022