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_HANDLE PrlDevDisplay_AsyncCaptureScaledScreenRegionToFile( 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
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.
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.
To get the return code from the PHT_JOB object, use the PrlJob_GetRetCode function. Possible value are:
PRL_ERR_INVALID_ARG - invalid handle or null pointer was passed.
PRL_ERR_SUCCESS - function completed successfully.