Collapse All
Virtuozzo Virtualization SDK C API Reference
ContentsIndex
PreviousUpNext
PrlStrList_GetItem Function
PHT_STRINGS_LIST

Extracts the specified string from the container.

Syntax
PRL_RESULT PrlStrList_GetItem(
    PRL_HANDLE hStringsList, 
    PRL_UINT32 nItemIndex, 
    PRL_STR sItemBuf, 
    PRL_UINT32_PTR pnItemBufSize
);
File

PrlApiCore.h

Parameters

hStringsList
A handle of type PHT_STRINGS_LIST identifying the string container.
nItemIndex
A numeric index identifying the string (beginning with 0). To determine the number of string in the container, use the PrlStrList_GetItemsCount function.
sItemBuf
[out] A pointer to a buffer that receives the result (a UTF-8 encoded, null-terminated string).
pnItemBufSize
[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. 

Links
Copyright ©2016-2017 Parallels International GmbH. All rights reserved.