Usage ¶
stopPerformanceMonitorProfile(session: hapi.Session, profile_id: int, file_path: str) → bool
Stop the Performance Monitor profile that matches the given profile id and save out the profile’s statistics to the specified file path on disk. The profile is cleared from memory after its statistics are saved to disk. Return hapi.result.InvalidArgument if no profile exists for the given id. Return hapi.result.Failure if the profile statistics could not be saved out to the specified file path. In this case, the profile is stopped but is not cleared from memory. You can call hapi.stopPerformanceMonitorProfile to attempt saving the profile to disk again.
session
The session of Houdini you are interacting with. See hapi.Session for more on sessions. Pass None to just use the default in-process session.
profile_id
The id of the profile to stop.
file_path
The path to the file where the profile statistics should be written to. Use the Performance Monitor file extension, .hperf, in the file name (i.e. /path/to/myProfile.hperf).