IVsPropertyFileIn::Read Method (UInt32, array<UInt16>^, UInt32, array<VSPROPERTYSTREAMPROPERTYTYPE>^, Object^, IErrorLog^)

Visual Studio 2015

Reads a property and value from the stream.

Namespace: Microsoft.VisualStudio.Shell.Interop
Assembly: Microsoft.VisualStudio.Shell.Interop (in Microsoft.VisualStudio.Shell.Interop.dll)

Syntax

C++

int Read(
	unsigned int cchPropertyName,
	array<unsigned short>^ szPropertyName,
	[OutAttribute] unsigned int% pcchPropertyNameActual,
	array<VSPROPERTYSTREAMPROPERTYTYPE>^ pvspspt,
	[OutAttribute] Object^% pvarValue,
	IErrorLog^ pIErrorLog
)

Parameters

cchPropertyName: Type: System::UInt32
[in] Length of szPropertyName.

szPropertyName: Type: array<System::UInt16>^
[out] String containing the property name.

pcchPropertyNameActual: Type: System::UInt32
[out] Length of property name.

pvspspt: Type: array<Microsoft.VisualStudio.Shell.Interop::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: Type: System::Object^
[out] A VARIANT containing the property value.

pIErrorLog: Type: Microsoft.VisualStudio.OLE.Interop::IErrorLog^
[in] The IErrorLog interface to use for reporting errors.

Return Value

Type: System::Int32

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

Implements

IVsPropertyStreamIn::Read(UInt32, array<UInt16>^, UInt32, array<VSPROPERTYSTREAMPROPERTYTYPE>^, Object^, IErrorLog^)

Remarks

COM Signature

From vsshell.idl:

[C++]

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