PrlOpTypeList_RemoveItem Function

Removes the specified item from the container.

Syntax

PRL_RESULT PrlOpTypeList_RemoveItem(
    PRL_HANDLE hOpTypeList, 
    PRL_UINT32 nItemIndex
);

File

PrlApi.h

Parameters

hOpTypeList

A handle of type PHT_OPAQUE_TYPE_LIST identifying the opaque type container.

nItemIndex

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

Returns

PRL_RESULT. Possible values:

PRL_ERR_INVALID_ARG - invalid handle or out of range index was passed.

PRL_ERR_SUCCESS - function completed successfully.

Links

PrlApi.h, PHT_OPAQUE_TYPE_LIST