IVsPropertyStreamIn.Read Method

Article
07/12/2014

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

'Declaration
Function Read ( _
    cchPropertyName As UInteger, _
    <OutAttribute> szPropertyName As UShort(), _
    <OutAttribute> ByRef pcchPropertyNameActual As UInteger, _
    <OutAttribute> pvspspt As VSPROPERTYSTREAMPROPERTYTYPE(), _
    <OutAttribute> ByRef pvarValue As Object, _
    pIErrorLog As IErrorLog _
) As Integer

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

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

abstract Read : 
        cchPropertyName:uint32 * 
        szPropertyName:uint16[] byref * 
        pcchPropertyNameActual:uint32 byref * 
        pvspspt:VSPROPERTYSTREAMPROPERTYTYPE[] byref * 
        pvarValue:Object byref * 
        pIErrorLog:IErrorLog -> int

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

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.

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.

Share via