Metodo IShellIconOverlay::GetOverlayIndex (shlobj_core.h)
Ottiene l'indice di sovrimpressione nell'elenco di immagini di sistema.
Sintassi
HRESULT GetOverlayIndex(
[in] PCUITEMID_CHILD pidl,
[in, out] int *pIndex
);
Parametri
[in] pidl
Tipo: PCUITEMID_CHILD
Puntatore a una struttura ITEMIDLIST che identifica l'oggetto la cui icona viene visualizzata.
[in, out] pIndex
Tipo: int*
Puntatore a un valore che indica l'indice di sovrimpressione (in base uno) nell'elenco di immagini di sistema. Questo indice equivale al valore iOverlay specificato quando si aggiunge un'immagine di sovrimpressione a un elenco di immagini private con la funzione ImageList::SetOverlayImage .
Valore restituito
Tipo: HRESULT
Questo metodo può restituire uno di questi valori.
Codice restituito | Descrizione |
---|---|
|
È stato trovato l'indice di una sovrimpressione. |
|
Non esiste alcuna sovrimpressione per questo file. |
|
Il file PIDL non è valido. |
|
L'argomento non è valido, ad esempio se pIndex è NULL. |
|
L'applicazione chiamante ha passato OI_ASYNC per indicare che l'operazione di calcolo dell'indice di sovrimpressione richiederà del tempo. |
Commenti
Per recuperare l'indice di sovrimpressione nell'elenco di immagini di sistema, chiamare SHGetIconOverlayIndex.
Se si imposta pIndex in modo che punti a OI_ASYNC quando si chiama questo metodo, il gestore overlay dell'icona shell potrebbe restituire E_PENDING anziché archiviare l'indice di sovrimpressione in pIndex. Questo valore restituito indica che il calcolo della sovrimpressione è un'operazione lenta e deve essere gestita in background. Quando un'implementazione di IShellIconOverlay restituisce E_PENDING, viene richiamata in un thread di lavoro in background senza il flag OI_ASYNC. Se non si usa OI_ASYNC quando si chiama GetOverlayIndex, il gestore di sovrimpressione deve calcolare l'indice di sovrimpressione e archiviare il valore in pIndex prima di restituire.
Requisiti
Requisito | Valore |
---|---|
Client minimo supportato | Windows 2000 Professional, Windows XP [solo app desktop] |
Server minimo supportato | Windows Server 2003 [solo app desktop] |
Piattaforma di destinazione | Windows |
Intestazione | shlobj_core.h |
DLL | Shell32.dll (versione 5.0 o successiva) |