Collapse All
Parallels C API Reference Guide
PrlDevDisplay_LockForRead Function
PrlApi.h Primary Display Capture Send Feedback

Locks the primary screen buffer disallowing any updates to the data it contains.

Syntax
PRL_RESULT PrlDevDisplay_LockForRead(
    PRL_HANDLE hVm
);
File
Parameters

hVm
A handle of type PHT_VIRTUAL_MACHINE identifying the virtual machine.
Returns

PRL_RESULT . Possible values:

PRL_ERR_INVALID_ARG - invalid handle or null pointer was passed.

PRL_ERR_SUCCESS - function completed successfully.

Remarks

When you obtain a screen capture, you should call this function first to prevent all further updates to the screen buffer. This is done in order to minimize the local machine resource usage, to speed up the screen buffer read operations, and to prevent possible data loss. To obtain the data from the buffer, use the PrlDevDisplay_GetScreenBuffer function. When you are done reading the data, call the PrlDevDisplay_Unlock to remove the lock.

Links
Copyright (c) 1999-2008 Parallels Software International Inc.
What do you think about this topic? Send feedback!