bool Get_Failure_Node_Record(Pointer_To_Buffer Buffer, long Length);

Parameters

• Pointer_To_Buffer Buffer: A pointer to a destination buffer.
• long Length: Length, in bytes, of destination buffer.

Return Values

• True: Successful retrieval.
• False: Error.

Remarks

This function retrieves a text node record of the last failed deserialization or serialization operation, and stores the contents in the output buffer, identified by Buffer. The value of Length specifies the maximum number of bytes to be copied.

This function is used for diagnostic purposes.  The client can use the node record to trace a rough path through the deserialization or serialization procedures, indicated by the constructs being processed by the procedure up to and including the actual failure point. For each construct processed, the construct name, size, and relative child position are reported.

A node record is stored if a function call failure occurs in a call to a critical-step method during deserialization or serialization, or if BAR_VALIDATION_FAILED is returned during deserialization.

If the node record is smaller in byte size than the value of Length, all bytes composing the record are copied, and no more.

The function fails if Length is nonpositive, if Pointer_To_Buffer is not a valid location, if the deserialization or serialization procedures did not fail, or if the deserialization or serialization procedures failed for a reason other than a function call failure or validation failure (e.g. out of node handles).

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]