PrlSrv_GetSupportedOses Function

Extracts supported guest OSes matrix from remote server (it's more proper way instead of using local synch API in case when client and server interoperate remotely).

Syntax

PRL_RESULT PrlSrv_GetSupportedOses(
    PRL_HANDLE hServer, 
    PRL_HANDLE_PTR phOsesMatrix
);

File

PrlApi.h

Parameters

hServer

A handle of type PHT_SERVER identifying the Parallels Service.

phOsesMatrix

pointer to the buffer for storing result.

Returns

PRL_RESULT . Possible values:

PRL_ERR_INVALID_ARG - invalid handle or null pointer was passed. PRL_ERR_NO_DATA - no supported OSes data (OSes matrix filling just after login procedure completed). Also this field can be empty in case when remote server is not supported this interface.

PRL_ERR_SUCCESS - function completed successfully.

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 results from the PHT_JOB object:

Use the PrlJob_GetResult function to obtain a handle to the PHT_RESULT object.
Use the PrlResult_GetParam function to obtain a handle of type PHT_GUEST_OSES_MATRIX which will contain complete list of supported guest OSes types, versions and defaults.

Links

PrlApi.h , PHT_SERVER