Package prlsdkapi :: Class ApiHelper
[ hide private ]
[ frames ] | no frames ]

Class ApiHelper

Provides common Parallels Python API system methods.

Instance Methods [ hide private ]
init ( self , version )
Initialize the Parallels API library.
init_ex ( self , nVersion , nAppMode , nFlags = 0 , nReserved = 0 )
Initialize the Parallels API library (extended version).
deinit ( self )
De-initializes the library.
get_version ( self )
Return the Parallels API version number.
get_app_mode ( self )
Return the Parallels API application mode.
get_result_description ( self , nErrCode , bIsBriefMessage = True , bFormated = False )
Evaluate a return code and return a description of the problem.
get_message_type ( self , nErrCode )
Evaluate the specified error code and return its classification (warning, question, info, etc.).
msg_can_be_ignored ( self , nErrCode )
Evaluate an error code and determine if the error is critical.
get_crash_dumps_path ( self )
Return the name and path of the directory where Parallels crash dumps are stored.
init_crash_handler ( self , sCrashDumpFileSuffix )
Initiate the standard Parallels crash dump handler.
create_strings_list ( self )
create_handles_list ( self )
create_op_type_list ( self , nTypeSize )
get_supported_oses_types ( self , nHostOsType )
Determine the supported OS types for the current API mode.
get_supported_oses_versions ( self , nHostOsType , nGuestOsType )
get_default_os_version ( self , nGuestOsType )
Return the default guest OS version for the specified guest OS type.
send_problem_report ( self , sProblemReport , bUseProxy , sProxyHost , nProxyPort , sProxyUserLogin , sProxyUserPasswd , nProblemSendTimeout , nReserved )
Send a problem report to the Parallels support server.
send_packed_problem_report ( self , hProblemReport , bUseProxy , sProxyHost , nProxyPort , sProxyUserLogin , sProxyUserPasswd , nProblemSendTimeout , nReserved )
unregister_remote_device ( self , device_type )
Unregister a remote device.
send_remote_command ( self , hVm , hCommand )
get_remote_command_target ( self , hCommand )
get_remote_command_index ( self , hCommand )
get_remote_command_code ( self , hCommand )
get_recommend_min_vm_mem ( self , nOsVersion )
Return recommended minimal memory size for guest OS defined in the OS version parameter.
create_problem_report ( self , nReportScheme )