Parallels Virtualization SDK
|
Captures a screen area of a remote virtual machine desktop, scales is down to the specified size, and saves it to a file on the client machine.
PRL_RESULT PrlDevDisplay_SyncCaptureScaledScreenRegionToFile( PRL_HANDLE hVm, PRL_CONST_STR fileName, PRL_IMAGE_FORMAT format, PRL_INT32 quality, PRL_UINT32 x, PRL_UINT32 y, PRL_UINT32 width, PRL_UINT32 height, PRL_UINT32 scaleWidth, PRL_UINT32 scaleHeight );
PrlApiVm.h
PRL_RESULT. Possible values:
PRL_ERR_INVALID_ARG - invalid handle or null pointer was passed.
PRL_ERR_SUCCESS - function completed successfully.
For local connections, the capture works almost instantly. For remote connections, the data must be transferred over network to the client machine, so it may take some time. This synchronous function is an equivalent of the asynchronous function PrlDevDisplay_AsyncCaptureScreenRegionToFile. You can use either function in your programs depending on your application needs.