Collapse All
Parallels Virtualization SDK
ContentsIndex
PreviousUpNext
PrlVmCfg_SetName Function
PHT_VM_CONFIGURATION

Sets the specified virtual machine name.

Syntax
PRL_RESULT PrlVmCfg_SetName(
    PRL_HANDLE hVmCfg, 
    PRL_CONST_STR sNewVmName
);
File

PrlApiVm.h

Parameters

hVmCfg
A handle of type PHT_VM_CONFIGURATION identifying the virtual machine configuration.
sNewVmName
The name to set. The value must be a a UTF-8 encoded, null-terminated string.

Returns

PRL_RESULT. Possible values: 

PRL_ERR_INVALID_ARG - invalid handle or null pointer was passed. 

PRL_ERR_SUCCESS - function completed successfully. 

Links
© 2021 Parallels International GmbH. All rights reserved.