IVsSettingsStore.GetBinary(String, String, UInt32, Byte[], UInt32[]) Method

Definition

Namespace:

Microsoft.VisualStudio.Shell.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

Returns the value of the requested property whose data type is SettingsType_Binary.

int GetBinary(std::wstring const & collectionPath, std::wstring const & propertyName, unsigned int byteLength, std::Array <byte> const & pBytes, std::Array <unsigned int> const & actualByteLength);

public int GetBinary (string collectionPath, string propertyName, uint byteLength, byte[] pBytes, uint[] actualByteLength);

abstract member GetBinary : string * string * uint32 * byte[] * uint32[] -> int

Public Function GetBinary (collectionPath As String, propertyName As String, byteLength As UInteger, Optional pBytes As Byte(), Optional actualByteLength As UInteger()) As Integer

Parameters

collectionPath

String

[in] The path of the collection.

propertyName

String

[in] The property name.

byteLength

UInt32

[in] The size in bytes of pBytes. Can be 0 if the caller wants to know the size of the value without copying it..

pBytes

Byte[]

[out] The buffer to fill with the property. Can be null if the caller wants to know the size of the buffer without copying it.

actualByteLength

UInt32[]

[out] The actual number of bytes returned.

Returns

Int32

Returns S_OK if the property was returned, S_FALSE if the property does not exist or E_INVALIDARG if the property type is not binary.

Remarks

This method is safe to access from any thread.