PrlStrList_RemoveItem Function

Removes the specified string from the container.

Syntax

PRL_RESULT PrlStrList_RemoveItem(
    PRL_HANDLE hStringsList, 
    PRL_UINT32 nItemIndex
);

File

PrlApi.h

Parameters

hStringsList

A handle of type PHT_STRINGS_LIST identifying the string container.

nItemIndex

A numeric index identifying the string. Index is a sequential number assigned to every item in the container. To determine the index of an item, call the PrlStrList_GetItem in a loop (from 0 to PrlStrList_GetItemsCount()). The iteration number is the index of the corresponding item.

Returns

PRL_RESULT. Possible values:

PRL_ERR_INVALID_ARG - invalid handle or null pointer was passed.

PRL_ERR_SUCCESS - function completed successfully.

Links

PrlApi.h, PHT_STRINGS_LIST