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

  BAR::Replace_Data

Purpose: To replace the current node's data from an input buffer.

bool Replace_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 writes the contents of the input buffer, identified by Buffer, to the current node’s encompassed data, replacing existing data if present. The value of Length specifies the number of bytes to be copied.

On success, this function implicitly calls Next. Format conversions such as byte order and number format do not occur as part of this function call.

The function fails if no file was loaded, if Length was negative, 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