Collapse All
Parallels Virtualization SDK
ContentsIndex
PreviousUpNext
PrlHandle_Free Function
Handle Functions

Frees the specified handle.

Syntax
PRL_RESULT PrlHandle_Free(
    PRL_HANDLE handle
);
File

PrlApiCore.h

Parameters

handle
Handle to free.

Returns

PRL_RESULT. Possible values: 

PRL_ERR_INVALID_ARG - invalid handle was passed. 

PRL_ERR_SUCCESS - function completed successfully. 

Remarks

Handles used within the Parallels API are reference counted. Each handle contains a count of the number of references to it held by other objects. A corresponding object stays in memory for as long as the count is greater than zero. A client application is responsible for freeing any handles that are no longer required. A handle can be freed using the PrlHandle_Free function. The function decreases the reference count by one. When the count reaches zero, the object is destroyed. Failing to free a handle after it has been used will result in a memory leak.

Links
© 2021 Parallels International GmbH. All rights reserved.