Teledyne LeCroy FireInspector Automation Application Programming Interface - Manual (Page 29)

25
FireInspector Automation User’s Manual CATC Version 1.0
2.3.13 IFwAnalyzer::RetrieveTree
Performs a bus reset with a type specified in reset_type and gap count specified in
gap_count, then retrieves and displays the topology tree in the FireInspector application.
Syntax
HRESULT RetrieveTree (
short reset_type, short gap_count );
Parameters
• gap_count – can be in the range 0 - 63.
•
reset_type – can be one of the following values:
• 3 – Short bus reset – indicates an arbitrated 1394 bus reset as defined by the 1394a
supplement.
• 4 – 1995 bus reset – initiates a long 1394-1995 bus reset.
• 5 – Forces the analyzer to become root, cycle master, and IRM.
• 6 – Forces the analyzer to become the bus manager.
• All other values are reserved.
Return values
• Returns NOERROR on success
• Returns E_FAIL if an error is encounteredRemarks
Remarks
Example
WSH:
C++:
IFwAnalyzer* fw_analyzer;
...
try
{
// short sResetType = 0; // Full reset
short sResetType = 3; // Short reset
// short sResetType = -1; // No reset
// short sGapCount = 63;
short sGapCount = 0;
HRESULT hr = fw_analyzer ->RetrieveTree( sResetType,
sGapCount );
}
catch( _com_error& )
{
::MessageBox( _T( "The analyzer device is not connected!"
) );
}