Hilfe:Hilfe

Aus API-Wiki
Version vom 24. April 2008, 14:52 Uhr von Nils Thomsen (Diskussion | Beiträge) (Pre-Alpha)

(Unterschied) ← Nächstältere Version | Aktuelle Version (Unterschied) | Nächstjüngere Version → (Unterschied)
Wechseln zu: Navigation, Suche

Übersicht

Dieses Wiki stellt eine umfangreiche Referenz der Windows-API-Deklarationen dar. Ziel ist es dabei, eine Sammlung an Funktionen zu bieten, die neben der Standard-API von Windows auch Spezialbereiche wie GDI+ abdeckt und Hilfestellungen bei der Implementierung durch kleine Codebeispiele, Referenzen zu wichtigen Artikel des Herstellers der API-Funktion und zusätzliche Informationen zu der Anwendung bereit stellt.


Verwendung des API-Katalog

In der Navigationsleiste des Wiki-System findet sich der Eintrag API-Katalog-Portal. Dieser Link führt Sie zu einer Übersicht aller eingetragenen API-Funktionen. Dabei sind die Einträge nach Verwendungszweck oder Themen gegliedert.

Nach der Auswahl eines Eintrages wird die Seite zu der entsprechenden Funktion angezeigt. Dabei gliedert sich jeder Eintrag nach folgendem Schema:

Kurze Beschreibung der Funktion

Eine kurze Beschreibung der Funktion.

Deklaration

Die Deklaration der Funktion. Diese kann in die IDE übernommen werden. Die Funktionen sind dabei weder als Private, noch als Public angegeben. Dies muss ggf. ergänzt werden.

Parameter

Eine Liste der Parameter. Hierbei wird jeder der eventuell benötigten Parameter näher beschrieben.

Rückgabe(n)

Hier wird näher auf die Rückgabe(n) der betreffenden Funktion eingegeben. Im Regelfall ist beschrieben, wie sich die Funktion bei Erfolg bzw. Misserfolg verhält.

Beispiel zur Verwendung (Optional)

Ein kurzer Codeausschnitt, der verdeutlicht, wie die Funktion aufgerufen wird.

Hinweise zur Verwendung (Optional)

Manche Funktionen verlangen bestimmte Vorraussetzungen, damit der Aufruf erfolgreich ist. Dies können z.B. additionale Komponenten sein, die benötigt werden. Ein Beispiel hierfür ist das Vorhandensein einer bestimmten Bibliothek.

Betriebsystem (Optional)

Eine Liste mit den unterstützten Betriebsystemen.

Verwandte Funktionen (Optional)

Eine Liste der Funktionen, die Themenverwandt sind.

Verweise (Optional)

Eine Liste mit Verweisen, z.B. der Herstellerseite, die nähere Informationen zu einem API / einer API-Funktion liefert.

Quellen

Eine Liste mit den Quellenangaben für einen Eintrag. Dabei umfasst die Quellenangabe die Quelle selbst, und den Zeitpunkt, zu welchem auf die Quelle verwiesen wurde. Dies dient vor allem dazu, dass falls die angegebene Deklaration auf eine ältere Version einer Funktion verweist, dem Leser die Möglichkeit geboten wird, die Quelle des entsprechenden Datums nachzuvollziehen.


Diskussion

Was ist eine Diskussion?

Für jeden Eintrag im API-Wiki wird vom System eine Diskussionsseite zur Verfügung gestellt. Diese bietet den Nutzern die MÖglichkeit, Unklarheiten über den Artikel mit dem Autor zu besprechen.

Zu finden ist diese Diskussionsseite über den Tab "Diskussion" in der Menüleiste. Die Diskussionsseite umfasst alle bisherigen Diskussionen, die zu der Seite geführt wurden.

Neuer Eintrag

Um einen neuen Eintrag in der Diskussion hinzuzufügen, klicken Sie auf den Tab "+". Auf der folgenden Seite können Sie ihren Eintrag tätigen.

Auf eine Diskussion antworten

Um auf eine Diskussion zu antworten, muss der aktuelle Absatz bearbeitet werden. Auf der rechten Seite auf höhe der fettgedruckten Überschrift findet sich hierfür der in eckigen Klammern stehende Text "[bearbeiten]".

Nach einem Klick öffnet sich das Editorfenster. Sie sehen nun den gesamten Text inklusive Wiki-Syntax.

Fügen Sie nun an den bisherigen Text anschließend Ihre Antwort ein. Dabei schreiben Sie bitte vor jeder neuen Zeile einen Doppelpunkt. Dies bewirkt ein Einrücken um eine Tab-Stufe:

THEMA

An dem Artikel gibt es zu bemägeln, dass er sich nicht ausreichend mit ... befasst.

Das Thema wurde ausreichend behandelt.
Diese Ansicht kann ich nicht teilen. Es fehlt ... .

Wie aus dem Beispiel ersichtlich wird, soll für jeden neuen Eintrag die entsprechende Anzahl an Doppelpunkten gesetzt werden. In der formatierten Darstellung ergibt sich somit eine Baumstruktur:

THEMA

An dem Artikel gibt es zu bemägeln, dass er sich nicht ausreichend mit ... befasst.

Das Thema wurde ausreichend behandelt.

Diese Ansicht kann ich nicht teilen. Es fehlt ... .


Nach dem Hinzufügen eines Eintrages fügen Sie bitte ihre Signatur ein. Dies bewerkstelligen Sie, indem Sie "14:52, 24. Apr. 2008 (CEST)" am Ende einfügen. Dieser Wiki-Tag wird zu Ihrem Namen samt Datum und Uhrzeit umgewandelt.


Versionen und Autoren

Der Tab "Versionen und Autoren" führt Sie zu einer Seite, die ein sehr leistungsstarkes Werkzeug zum Vergleichen alle bisherigen Artikelversionen zur Verfügung stellt.

Nach dem Öffnen wird eine Seite angezeigt, die alle Artikelversionen und Autoren untereinander auflistet. Mittels der Optionsknöpfe können Sie festlegen, welche Versionen untereinander verglichen werden.

In der Folgeseite, die nach einem Klick auf "Gewählte Versionen vergleichen" erscheint, werden alle am Text durchgeführten Änderungen gezeigt. Rot dargestellt werden dabei sämtliche Änderungen hervorgehoben.

Beobachten

Durch den Tab beobachten werden Sie zu einer Seite weitergeleitet, die die Beobachtung eines Artikels oder Diskussion ermöglicht. Dabei werden Sie über sämtliche Änderungen informiert. Um eine Beobachtung zu entfernen klicken Sie entweder bei dem betreffenden Artikel auf "Nicht mehr beobachten", oder wählen in ihrem persönlichen Menü "Beobachtungsliste", welches sich zu oberst auf der Wiki-Seite befindet. Hier können Sie alle Ihrer Beobachtungen einsehen und bearbeiten.


Persönliches Menü

Wie kurz unter "Beobachten" angesprochen, hat jeder Nutzer ein persönliches Menü, welches sich im Kopf der Seite des API-Wiki befindet.

Das Menü beinhaltet folgende Punkte:

- Ihren Namen - Eigene Diskussion - Einstellungen - Beobachtungsliste - Eigene Beiträge - Abmelden

Ihren Namen

Öffnet Ihre persönlichen Seite, die Sie frei verändern können. Sie ist für jeden Nutzer sichtbar.

Eigene Diskussion

Öffnet die Diskussionsseite Ihrer persönlichen Seite.

Einstellungen

Öffnet Ihre persönlichen Einstellungen.

Beobachtungsliste

Öffnet eine Auflistung aller Ihrer beobachteten Seiten.

Eigene Beiträge

Öffnet eine Auflistung aller Ihrer bisherigen Beiträge.

Abmelden

Meldet Sie vom API-Wiki ab.