DsGetIcon-Funktion (dsclient.h)
Die DsGetIcon-Funktion ruft das Symbol für eine bestimmte Objektklasse ab. Diese Funktion ist veraltet. Neue Anwendungen sollten die IDsDisplaySpecifier::GetIcon-Methode verwenden, um diese Funktion auszuführen.
Syntax
HICON DsGetIcon(
[in] DWORD dwFlags,
[in] LPCWSTR pszObjectClass,
[in] INT cxImage,
[in] INT cyImage
);
Parameter
[in] dwFlags
Enthält eine Reihe von Flags, die den Typ des abzurufenden Symbols angeben. Dies kann eine Kombination aus mindestens einem der folgenden Werte sein.
DSGIF_ISNORMAL
Ruft das normale Symbol für die Objektklasse ab.
DSGIF_ISOPEN
Ruft das geöffnete Symbol, z. B. einen geöffneten Ordner, für die Objektklasse ab. Wenn die Objektklasse kein geöffnetes Symbol aufweist, versucht diese Funktion, das normale Symbol für die Objektklasse abzurufen.
DSGIF_ISDISABLED
Ruft das deaktivierte Symbol, z. B. einen deaktivierten Benutzer, für die Objektklasse ab. Wenn die Objektklasse kein deaktiviertes Symbol aufweist, versucht diese Funktion, das normale Symbol für die Objektklasse abzurufen.
DSGIF_GETDEFAULTICON
Wenn kein Symbol für die Objektklasse gefunden werden kann, gibt diese Funktion ein Standardsymbol zurück. Wenn dieses Flag nicht angegeben ist und kein Symbol für die Objektklasse gefunden werden kann, gibt diese Funktion NULL zurück.
DSGIF_DEFAULTISCONTAINER
Wenn kein Symbol für die Objektklasse gefunden werden kann, gibt diese Funktion das Containersymbol als Standardsymbol zurück. Wenn dieses Flag nicht angegeben ist und kein Symbol für die Objektklasse gefunden werden kann, gibt diese Funktion NULL zurück.
[in] pszObjectClass
Zeiger auf eine mit NULL beendete Unicode-Zeichenfolge, die den Namen der Objektklasse enthält, für die das Symbol abgerufen werden soll. Beispiele für den Objektklassennamen sind "user" und "container".
[in] cxImage
Enthält die gewünschte Breite des Symbols in Pixel. Diese Funktion ruft das Symbol ab, das dieser Breite am ehesten entspricht.
[in] cyImage
Enthält die gewünschte Höhe des Symbols in Pixel. Diese Funktion ruft das Symbol ab, das dieser Höhe am ehesten entspricht.
Rückgabewert
Gibt ein Handle an das Symbol zurück, wenn der Vorgang erfolgreich war oder andernfalls NULL . Der Aufrufer muss dieses Symbol zerstören, wenn es nicht mehr benötigt wird, indem dieses Handle an DestroyIcon übergeben wird.
Anforderungen
Anforderung | Wert |
---|---|
Unterstützte Mindestversion (Client) | Windows Vista |
Unterstützte Mindestversion (Server) | Windows Server 2008 |
Zielplattform | Windows |
Kopfzeile | dsclient.h |
Bibliothek | Dsuiext.lib |
DLL | Dsuiext.dll |