IVsSettingsStore::GetBinary Method (String^, String^, UInt32, array<Byte>^, array<UInt32>^)

Visual Studio 2015
 

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

Namespace:   Microsoft.VisualStudio.Shell.Interop
Assembly:  Microsoft.VisualStudio.Shell.Interop.10.0 (in Microsoft.VisualStudio.Shell.Interop.10.0.dll)

C#
C++
F#
VB
Copy 
int GetBinary(
	String^ collectionPath,
	String^ propertyName,
	unsigned int byteLength,
	array<unsigned char>^ pBytes,
	array<unsigned int>^ actualByteLength
)

Parameters

collectionPath
Type: System::String^

[in] The path of the collection.

propertyName
Type: System::String^

[in] The property name.

byteLength
Type: System::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
Type: array<System::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
Type: array<System::UInt32>^

[out] The actual number of bytes returned.

Return Value

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

To find the size of the property, pass 0 in the byteLength parameter. The actual length of the property in bytes will be returned in actualByteLength, but no data will be copied to pBytes.

Return to top
Show: