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

 BAR::Write_Member

Purpose: To write the current node's structured data member from a native structure member.
bool Write_Member(BAR_String MemberName, Pointer_To_Buffer MemberPtr)


Parameters

  • BAR_String MemberName: The variable name of the structure member.
  • Pointer_To_Buffer MemberPtr: A pointer to a source buffer.

Return Values

  • True: Successful copy.
  • False: Error.

Remarks

This function writes to a specific child of the data structure node (the current node); it is assumed that the current node is a data structure. The child from which to read is identified by its variable name in MemberName.

If the child is of simple type, the write operation is equivalent to that found in unitary write functions. If the child is of structure type, the write operation is equivalent to Write_Struct.

The error BAR_INVALID_WRITE_CONTEXT is set if the current node is not of data structure type or an array of structure type.

BAR_INVALID_NAME is set if MemberName does not identify a member of the current node.

This function does not move the node cursor.

Compatibility

  All Platforms Win32 C++ LIB
BAR version X 1.1
  All Platforms Win32
BARfly version n/a n/a


  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