Discuss this help topic in MsgConnect Forum

Filter: C++  Pascal  C#  VB.NET  Java  Java ME  ActiveX  DLL 



DataTree.ReadBinary

DataTree     See also    


Reads binary data from the entry into the Buffer.

Declaration

[C++]
    bool ReadBinary(char* Key, char* ValueName, void* Buffer, long& Value);

[Pascal]
    function ReadBinary(Key : string; ValueName : string; var Buffer; var BufferLen : integer): Boolean;

[VB6]
    not applicable;

[ActiveX]
    not applicable;

[C#]
    public bool ReadBinary(string Key, string ValueName, ef byte[] Buffer);

[VB.NET]
    Public Function ReadBinary(ByVal Key As String, ByVal ValueName As String, ByRef Buffer As Byte()) As Boolean

[Java]
    public boolean ReadBinary(String Key, String ValueName, ByteArrayHolder Buffer);

[Java ME]
    public boolean ReadBinary(String Key, String ValueName, ByteArrayHolder Buffer);

[DLL]
    not applicable;

Parameters

  • Key - key name. For more information look here.
  • ValueName - value name. For more information look here.
  • Buffer - name of the buffer to which data is readed.
  • BufferLen - is set to the actual length of data if data copied successfully. BufferLen is set to the length needed if it's smaller then needed.

Return value

    True if data was copied successfully.
    False if BufferLen is smaller than needed.

Description

    Use this method to read binary data from the entry into the Buffer. If BufferLen is smaller then needed, BufferLen is set to the length needed and False is returned. Buffer is not changed in this case. If data is copied successfully True is returned and BufferLen is set to the actual length of data.

See also:     ReadBool     ReadInteger     ReadDouble     ReadString     ReadMultiString     ReadWideString     WriteBinary    

Discuss this help topic in MsgConnect Forum