cwbUN_GetIndexFromPidl

Purpose

Extracts the item index field from a fully-qualified Unity item identifier list.

Syntax

CWBAPI unsigned int WINAPI cwbUN_GetIndexFromPidl(
    LPCITEMIDLIST pidl,
    ULONG* piIndex
    );

Parameters

LPCITEMIDLIST pidl - input

Pointer to an ITEMIDLIST (item identifier list) structure from which the item index will be extracted.

ULONG* piIndex - output

Address of an unsigned long integer that will receive the item index.

Return Codes

The following list shows common return values:

CWB_OK

Successful completion.

CWBUN_FORMAT_NOT_VALID

The specified item identifier list is not valid.

Usage

None