Collapse All
Parallels Virtualization SDK
ContentsIndex
PreviousUpNext
PrlSrv_Register3rdPartyVm Function
PHT_SERVER

Registers an existing 3rd party virtual machine with Parallels Service.

Syntax
PRL_HANDLE PrlSrv_Register3rdPartyVm(
    PRL_HANDLE hServer, 
    PRL_CONST_STR strVmConfigPath, 
    PRL_CONST_STR strVmRootDirPath, 
    PRL_UINT32 nFlags
);
File

PrlApiVm.h

Parameters

hServer
A handle of type PHT_SERVER identifying the Parallels Service.
strVmConfigPath
[required] An absolute path to the virtual machine configuration file (*.vmx for example)
strVmRootDirPath
[optional] An absolute path to the virtual machine root directory where virtual machine home directory will be created.
nFlags
Flags bitset: 0 - Default behavior PR3F_ALLOW_UNKNOWN_OS

  • to allow undetectable OS

PR3F_FORCE

  • to skip errors when possible and force registration

Returns

A handle of type PHT_JOB containing the results of this asynchronous operation, including the return code and a handle of type PHT_VIRTUAL_MACHINE containing information about the virtual machine that was registered. 

PRL_INVALID_HANDLE if there's not enough memory to instantiate the job object. 

Remarks

 

To get the return code from the PHT_JOB object, use the PrlJob_GetRetCode function. Possible values are: 

PRL_ERR_INVALID_ARG - invalid handle was passed. 

PRL_ERR_SUCCESS - function completed successfully. 

To get the results from the PHT_JOB object:

  1. Use the PrlJob_GetResult function to obtain a handle to the PHT_RESULT object.
  2. Use the PrlResult_GetParam function to obtain a handle of type PHT_VIRTUAL_MACHINE.
Links
© 2021 Parallels International GmbH. All rights reserved.