Collapse All
Parallels Virtualization SDK
ContentsIndex
PreviousUpNext
PHT_RESULT
Functions  Functions by Handle  Legend

The PHT_RESULT handle is a container that contains results of an asynchronous operation. The handle is obtained from the PHT_JOB object returned by the asynchronous function.

Description

To obtain a handle, use the PrlJob_GetResult function call after the job completes. Once you have the handle, use functions from this group to extract the results of the corresponding asynchronous operation. The PHT_RESULT object can contain a string, an array of strings, a handle, or an array of handles. 

If you are expecting a single result, then, depending on the result type (a string or a handle), use the PrlResult_GetParamAsString or the PrlResult_GetParam function respectively. 

If the function returns multiple results, first, use the PrlResult_GetParamsCount function to get the number of the results. Then use the PrlResult_GetParamByIndex or the PrlResult_GetParamByIndexAsString function to get individual results. The index of the array begins at 0. 

For more information, please also see the Parallels Virtualization SDK Programmer's Guide.

Functions
 
Name 
Description 
 
Obtains a handle to an object containing the results of the corresponding asynchronous operation. 
 
Obtains a string result from the result object. 
 
Obtains a handle from the result object identified by the index. 
 
Obtains a string result from the result object identified by the index. 
 
Determines the number of items in the specified result object. 
 
Get param token by index
@param valid PRL_HANDLE @param index of parameter @param pointer to a command specific object that contains parameter value @return PRL_RESULT
Links
© 2021 Parallels International GmbH. All rights reserved.