This topic has not yet been rated - Rate this topic

IVsPropertyStreamIn.Read Method

Visual Studio 2008

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++

JScript

int Read(
	uint cchPropertyName,
	ushort[] szPropertyName,
	out uint pcchPropertyNameActual,
	VSPROPERTYSTREAMPROPERTYTYPE[] pvspspt,
	out Object pvarValue,
	IErrorLog pIErrorLog
)

Parameters

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

szPropertyName: Type: System.UInt16[]
[out] String containing the property name.

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

pvspspt: Type: 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.

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
);

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Reference

IVsPropertyStreamIn Interface

IVsPropertyStreamIn Members

Microsoft.VisualStudio.Shell.Interop Namespace

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)

Community Additions

ADD