Partager via


IVsWritableSettingsStore.GetBinary Method (String, String, UInt32, array<Byte[], array<UInt32 )

Returns the value of a property of type SettingsType_Binary.

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

Syntax

'Declaration
Function GetBinary ( _
    collectionPath As String, _
    propertyName As String, _
    byteLength As UInteger, _
    <OutAttribute> pBytes As Byte(), _
    <OutAttribute> actualByteLength As UInteger() _
) As Integer
int GetBinary(
    string collectionPath,
    string propertyName,
    uint byteLength,
    byte[] pBytes,
    uint[] actualByteLength
)
int GetBinary(
    [InAttribute] String^ collectionPath, 
    [InAttribute] String^ propertyName, 
    [InAttribute] unsigned int byteLength, 
    [OutAttribute] array<unsigned char>^ pBytes, 
    [OutAttribute] array<unsigned int>^ actualByteLength
)
abstract GetBinary : 
        collectionPath:string * 
        propertyName:string * 
        byteLength:uint32 * 
        pBytes:byte[] byref * 
        actualByteLength:uint32[] byref -> int
function GetBinary(
    collectionPath : String, 
    propertyName : String, 
    byteLength : uint, 
    pBytes : byte[], 
    actualByteLength : uint[]
) : int

Parameters

  • collectionPath
    Type: String

    [in] The path of the collection.

  • propertyName
    Type: String

    [in] The property name.

  • byteLength
    Type: 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<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<UInt32[]

    [out] The actual number of bytes returned.

Return Value

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

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.

.NET Framework Security

See Also

Reference

IVsWritableSettingsStore Interface

GetBinary Overload

Microsoft.VisualStudio.Shell.Interop Namespace