Collapse All
Parallels C API Reference Guide
ContentsIndex
PreviousUpNext
PrlSrv_GetCommonPrefs Function
PrlApi.h  PHT_SERVER  Example  Send Feedback

Returns a handle of type PHT_DISP_CONFIG containing the specified Parallels Service preferences information.

Syntax
PRL_HANDLE PrlSrv_GetCommonPrefs(
    PRL_HANDLE hServer
);
File
Parameters

hServer
A handle of type PHT_SERVER identifying the Parallels Service.

Returns

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. 

 

Remarks

 

To get the return code from the PHT_JOB object, use the PrlJob_GetRetCode function. Possible values are: 

PRL_ERR_INVALID_ARG - invalid handle was passed. 

PRL_ERR_SUCCESS - function completed successfully. 

To get the result from the PHT_JOB object:

  1. Use the PrlJob_GetResult function to obtain a handle to the PHT_RESULT object.
  2. Use the PrlResult_GetParam function to obtain a handle of type PHT_DISP_CONFIG containing the Parallels Service preferences.
Example

The following example illustrates how to obtain a handle of type PHT_DISP_CONFIG.

hJob =
PrlSrv_GetCommonPrefs( hServer );
PrlJob_Wait( hJob, 10000 );
PrlJob_GetResult( hJob, &hJobResult );
PrlHandle_Free( hJob );

// Get the PHT_DISP_CONFIG handle.
PRL_HANDLE hHandle;
PrlResult_GetParam( hJobResult, &hHandle );
Links
Copyright (c) 1999-2009 Parallels Software International Inc.
What do you think about this topic? Send feedback!