BARfly Help - BAR Interfacial Function Reference - BAR data writing functions

  BAR::Add_Block_Data

Purpose: To append data to the end of the current node's data from an input buffer.

bool Add_Block_Data(Pointer_To_Buffer Buffer, long Length);


Parameters

  • Pointer_To_buffer Buffer: A pointer to a source buffer.
  • long Length: Length, in bytes, of source buffer.

Return Values

  • True: Successful copy.
  • False: Error.

Remarks

This function appends data to the end of an unorganized block. The ultimate size of the current node becomes the previous value returned by Get_Size plus Length. If the block was empty, the function has the same effect as Replace_Data.

The error BAR_INVALID_WRITE_CONTEXT is set if the current node is not an unorganized block.

This function does not move the node cursor.

The function fails if no file was loaded, if Length was nonpositive, if the type of construct was not an unorganized block, or if there was not enough memory to complete the operation.

Compatibility

  All Platforms Win32 C++ LIB
BAR version 1.1 1.1
  All Platforms Win32
BARfly version 1.0 1.0


  See also:  [BAR type lookup functions] [BAR loading and saving functions] [BAR node navigation functions]
[BAR node information functions] [BAR data reading functions] [BAR data writing functions] [BAR miscellaneous functions]


BARfly Help Copyright © 2009 Christopher Allen