AGI AgAsHpopPlugin 6 Send comments on this topic.
PreNextStep Method (IAgAsHpopPlugin)
See Also 
Result
Interface component to access inputs and outputs.
Windows








Description

Triggered just before the next propagation step is attempted. Use the input interface to access force model settings. Returning false will turn this callback off.

Syntax

[Visual Basic .NET]
Public Function PreNextStep( _
   ByVal Result As AgAsHpopPluginResult _
) As Boolean

[C#]
public bool PreNextStep(
AgAsHpopPluginResult Result
);

[Managed C++]
public: bool PreNextStep(
AgAsHpopPluginResult ^ Result
);

[Unmanaged C++]
public: HRESULT PreNextStep(
AgAsHpopPluginResult * Result,
VARIANT_BOOL * ReturnValue
);

[VBScript]
'Function object.PreNextStep(...)  returns type Boolean
' Result is type AgAsHpopPluginResult (an object)
result = object.PreNextStep(Result)

[Perl]
$return_value = $objectReference->PreNextStep(# $return_value is of type int
$Result# type AgAsHpopPluginResult (object reference)
);

Parameters

Result
Interface component to access inputs and outputs.

Return Type

Return true to indicate success, false to indicate failure.  If false is returned, this method will no longer be called from HPOP.

See Also

© 2017 Analytical Graphics, Inc. All Rights Reserved.

ODTK 6.5