IVsPropertyStreamIn.Read Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Reads a property and value from the stream.
public:
int Read(System::UInt32 cchPropertyName, cli::array <System::UInt16> ^ szPropertyName, [Runtime::InteropServices::Out] System::UInt32 % pcchPropertyNameActual, cli::array <Microsoft::VisualStudio::Shell::Interop::VSPROPERTYSTREAMPROPERTYTYPE> ^ pvspspt, [Runtime::InteropServices::Out] System::Object ^ % pvarValue, Microsoft::VisualStudio::OLE::Interop::IErrorLog ^ pIErrorLog);
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);
public int Read (uint cchPropertyName, ushort[] szPropertyName, out uint pcchPropertyNameActual, Microsoft.VisualStudio.Shell.Interop.VSPROPERTYSTREAMPROPERTYTYPE[] pvspspt, out object pvarValue, Microsoft.VisualStudio.OLE.Interop.IErrorLog pIErrorLog);
abstract member Read : uint32 * uint16[] * uint32 * Microsoft.VisualStudio.Shell.Interop.VSPROPERTYSTREAMPROPERTYTYPE[] * obj * Microsoft.VisualStudio.OLE.Interop.IErrorLog -> int
Public Function Read (cchPropertyName As UInteger, szPropertyName As UShort(), ByRef pcchPropertyNameActual As UInteger, pvspspt As VSPROPERTYSTREAMPROPERTYTYPE(), ByRef pvarValue As Object, pIErrorLog As IErrorLog) As Integer
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.
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
);