Collapse All
Parallels Virtualization SDK
ContentsIndex
PreviousUpNext
PrlSrv_RegisterVmEx Function
PHT_SERVER

Registers an existing virtual machine with Parallels Service.

Syntax
PRL_HANDLE PrlSrv_RegisterVmEx(
    PRL_HANDLE hServer, 
    PRL_CONST_STR strVmDirPath, 
    PRL_UINT32 nFlags
);
File

PrlApiVm.h

Parameters

hServer
A handle of type PHT_SERVER identifying the Parallels Service.
strVmDirPath
An absolute path the virtual machine directory to register.
nFlags
A bitset of flags. Allowed next values: 

0 - no flags. It's behaviour by default ( as PrlSrv_RegisterVm() ) 

PACF_NON_INTERACTIVE_MODE
to use non-interactive mode. In interactive mode, a client may receive questions from the Parallels Service, which it is expected to answer in order for the operation to continue. In non-interactive mode, the Parallels Service will make decisions on its own. 

PRVF_REGENERATE_VM_UUID
to generate new VM identity after 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.