PrlVm_ChangeSid Function

Generates and assigns a new Windows SID to the specified virtual machine running Windows guest OS.

Syntax

PRL_HANDLE PrlVm_ChangeSid(
    PRL_HANDLE hVm, 
    PRL_UINT32 nFlags
);

File

PrlApi.h

Parameters

hVm

A handle of type PHT_VIRTUAL_MACHINE identifying the virtual machine.

nFlags

Reserved for future use.

Returns

A handle of type PHT_JOB containing the results of this asynchronous operation or PRL_INVALID_HANDLE if there's not enough memory to instantiate the job object. To get the return code from the PHT_JOB object, use the PrlJob_GetRetCode function. Possible values are: PRL_ERR_INVALID_ARG - invalid handle or null pointer was passed. PRL_ERR_SUCCESS - function completed successfully. PRL_ERR_UNINITIALIZED â€“ unknown PHT_VIRTUAL_MACHINE handle or invalid binding to server connection.

Remarks

This function is useful when cloning or migrating a virtual machine to another host to avoid conflicts. Please note that this functionality is applicable to Windows guests only. Parallels Tools must be installed in the virtual machine. The machine must be stopped before calling this function.

Links

PrlApi.h , PHT_VIRTUAL_MACHINE