bool Get_Failure_Call_Stack(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 record of the call stack of the last failed global or member function call, 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 get a snapshot of the call stack at the time of the failure, which might be several function calls “deep.” For each function’s stack frame stored in the stack, the name, opcode index, and member scope name (if applicable) are reported.

A record of the call stack is stored if Global_Function_Call or Member_Function_Call returns false, or if a critical error occurs in a call to a critical-step method during deserialization or serialization.

If the call stack 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, or if there was no function call failure.

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]