Interstage Shunsaku Data Manager Application Development Guide - Microsoft(R) Windows(R) 2000/ Microsoft(R) Windows Server(TM) 2003 - - UNIX -

8.1.6 C API Function Information

Information about a function invoked from an application is output when the method is invoked by an application, when the method returns, and when a function execution error occurs.

Output Format

The API snapshot is output in CSV format.

The output format for each output level is shown below.

Level 1

When a function is invoked

Application name, connection handle ID, thread ID, date, time, Call, function name

When a function returns

Application name, connection handle ID, thread ID, date, time, Return, function name, function execution time, return value, Performance Information

When an error is returned

Application name, connection handle ID, thread ID, date, time, Error, function name, function execution time, return value, error details string, Performance Information

Level 2

When a function is invoked

Application name, connection handle ID, thread ID, date, time, Call, function name,,, input parameter information

When a function returns

Application name, connection handle ID, thread ID, date, time, Return, function name, function execution time, return value, output parameter information, Performance Information

When an error is returned

Application name, connection handle ID, thread ID, date, time, Error, function name, function execution time, return value, error details string, Performance Information

Output Content

The following table lists the items that are output and their content.

[Table 8-4 Content of the C API Function Information Output]

Output item	Content	Output level
		Level 1	Level 2
Application name	Displays the name of the invoking application.
Connection handle ID	Outputs the connection handle identifier. This value is returned by the ShunAllocHandle function when connection handles are allocated.
Thread ID	Outputs the thread ID.
Date	Outputs the function invocation start/end date in the format "yyyy/mm/dd".
Time	Outputs the function invocation start/end time in the format "hh:mm:ss.ms".
Call Return Error	"Call": Indicates that the information relates to when a function was invoked. "Return": Indicates that the information relates to when a function was returned. "Error": Indicates that an error occurred when a function was executed.
Function name	Outputs the name of the C API function that was invoked.
Function execution time	Outputs the period (in seconds) between the time that a function was invoked and the time it returned.
Return value	Outputs the return value. "SHUN_SUCCESS": Indicates that the function terminated normally. "SHUN_ERROR": Indicates that a problem was detected while the function was running.
Error details string	Outputs a details string if an error occurs when a function is invoked. This item will not be output if no details string is included.
Input parameter information	Outputs input parameter information (parameter type and value) in the following format when a function is invoked: (Parameter type) Value This item will not be output if there are no input parameters.	x
Output parameter information	Outputs output parameter information (parameter type and value) in the following format when a function returns: (Parameter type) Value This item will not be output if there are no output parameters.	x
Performance Information	Outputs the number that is output in the performance log (The 8-bytes number from the conductor (*1)

:Item is output
x :Item is not output

*1) Refer to Output Information of Performance Log in the Operator's Guide for more information on the output of performance log.

Output Examples

The information that is output to a snapshot is output in the character code of the platform where the C API is operating.

Output examples for the different output levels are provided below.

Level 1

Normal Termination

"sample_hit_count",9449912,2820,"2006/10/22","11:58:10.380","Call","ShunConnect"
"sample_hit_count",9449912,2820,"2006/10/22","11:58:10.380","Return","ShunConnect",0.015,"SHUN_SUCCESS",,"42d234c100000100"

Abnormal Termination

"sample_hit_count",9449912,3540,"2006/10/22","14:34:37.270","Call","ShunConnect"
"sample_hit_count",9449912,3540,"2006/10/22","14:34:38.286","Error","ShunConnect",1.016,
"SHUN_ERROR","shn30654u:Either the director or the conductor has not been started, or the port number is incorrect. <ShunConnect>",

Level 2

Normal Termination

"sample_hit_count",9449912,3116,"2006/10/22","11:58:19.661","Call","ShunConnect",,,"(SHUNHCON)3554328[00363C18] (char*)DirSvr1 (int)33101 (char*)shunsakuFile1"
"sample_hit_count",9449912,3116,"2006/10/22","11:58:19.661","Return","ShunConnect",0.015,"SHUN_SUCCESS","","42d234c100000100"

Abnormal Termination

"sample_hit_count",9449912,3540,"2006/10/22","14:34:37.270","Call","ShunConnect",,,
"(SHUNHCON)3427440[00344C70] (char*) localhost (int)10007 (char*)file1"
"sample_hit_count",9449912,3540,"2006/10/22","14:34:38.286","Error","ShunConnect",1.016,
"SHUN_ERROR","shn30654u:Either the director or the conductor has not been started, or the port number is incorrect. <ShunConnect>",

• Enclose character string items in double quotes (").
• Do not enclose numerical values in double quotes (").

The operation of each connection can be traced chronologically by filtering the collected log file with the connection handleID.