Collapse All
Parallels Virtualization SDK
ContentsIndex
PreviousUpNext
PrlRunningTask_GetTaskParametersAsString Function
PHT_RUNNING_TASK

Returns task parameters as a string.

Syntax
PRL_RESULT PrlRunningTask_GetTaskParametersAsString(
    PRL_HANDLE hRunningTask, 
    PRL_STR sParamsStr, 
    PRL_UINT32_PTR pnsParamsStrBufLength
);
File

PrlApiDisp.h

Parameters

hRunningTask
A handle of type PHT_RUNNING_TASK identifying the task.
sParamsStr
[out] A pointer to a buffer that receives the result (a UTF-8 encoded, null-terminated string).
pnsParamsStrBufLength
[in] The size of the output buffer (in bytes). Set the buffer pointer to null and this parameter's value to zero to receive the required size. [out] The required output buffer size.

Returns

PRL_RESULT. Possible values are: 

PRL_ERR_INVALID_ARG - invalid handle or null pointer was passed. 

PRL_ERR_BUFFER_OVERRUN - the size of the output buffer is not large enough. The parameter that is used to specify the size will contain the required size. 

PRL_ERR_SUCCESS - function completed successfully. 

Remarks

Value returns in UTF-8 encoding. Null char ('0') adding to the end of string.

Links
© 2021 Parallels International GmbH. All rights reserved.