IVsWritableSettingsStore.SetBinary(String, String, UInt32, Byte[]) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assemblies:: Microsoft.VisualStudio.Shell.14.0.dll, Microsoft.VisualStudio.Shell.Interop.10.0.dll

Assemblies:: Microsoft.VisualStudio.Shell.15.0.dll, Microsoft.VisualStudio.Shell.Interop.10.0.dll

Assembly:: Microsoft.VisualStudio.Shell.Interop.10.0.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.9.37000

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.

Sets the value of a binary property with the specified byte array. If the previous data type of the property is not SettingsType_Binary, this method overwrites it. If the property does not exist, it creates one

public:
 int SetBinary(System::String ^ collectionPath, System::String ^ propertyName, System::UInt32 byteLength, cli::array <System::Byte> ^ pBytes);

public:
 int SetBinary(Platform::String ^ collectionPath, Platform::String ^ propertyName, unsigned int byteLength, Platform::Array <byte> ^ pBytes);

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

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

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

Public Function SetBinary (collectionPath As String, propertyName As String, byteLength As UInteger, pBytes As Byte()) As Integer

Parameters

collectionPath: String

[in] The path to the collection.

propertyName: String

[in] The name of the property.

byteLength: UInt32

[in] The number of bytes to write.

pBytes: Byte[]

[in] The array of bytes to write.

Returns

Int32

Returns S_OK if the property was set. If the collection does not exist, the method returns E_INVALIDARG.

Remarks

If byteLength is 0, then pBytes can be null, but otherwise it should point to a BYTE array of specified size.

Applies to