PrlHndlList_RemoveItem Function

Removes a handle from the container.

Syntax

PRL_RESULT PrlHndlList_RemoveItem(
    PRL_HANDLE hHandlesList, 
    PRL_UINT32 nItemIndex
);

File

PrlApiCore.h

Parameters

hHandlesList

A handle of type PHT_HANDLES_LIST identifying the container.

nItemIndex

A numeric index of the handle to remove (beginning with zero). To get the total number of handles in the container, use the PrlHndlList_GetItemsCount function.

Returns

PRL_RESULT. Possible values are:

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

PRL_ERR_SUCCESS - operation completed successfully.

Links

PHT_HANDLES_LIST