Schnittstelle zum Erstellen einer neuen Steam-Instanz oder zum Herstellen einer Verbindung zu einer existierenden Steam-Instanz, ganz gleich, ob sie sich in einem anderen Prozess befindet oder lokal ist.
In den meisten Fällen wird all dies automatisch über
SteamAPI_Init behandelt.
Sie müssen diese APIs nur dann verwenden, wenn Sie mit einem komplexeren Versionsverwaltungsschema arbeiten oder wenn Sie einen Multiplex-Spielserver implementieren möchten, in dem ein einziger Prozess mehrere Spiele gleichzeitig mit unabhängigen Spielserver-Steam-IDs ausführt.
Memberfunktionen
Memberfunktionen für
ISteamClient werden über die globale Accessorfunktion
SteamClient() aufgerufen.
BReleaseSteamPipe
bool BReleaseSteamPipe( HSteamPipe hSteamPipe );
| Name | Typ | Beschreibung |
|---|
| hSteamPipe | HSteamPipe | Die zu veröffentlichende Pipe. |
Gibt eine zuvor erstellte Kommunikationspipe frei.
NICHT THREADSICHER – Stellen Sie sicher, dass bei einem Aufruf keine anderen Threads auf die Steamworks-API zugreifen!
Rückgabe: bool
true, wenn die Pipe gültig war und erfolgreich veröffentlicht wurde; sonst
false.
BShutdownIfAllPipesClosed
bool BShutdownIfAllPipesClosed();
Löst das globale Herunterfahren der DLL aus, wenn alle Pipes geschlossen sind.
Rückgabe: bool
ConnectToGlobalUser
HSteamUser ConnectToGlobalUser( HSteamPipe hSteamPipe );
| Name | Typ | Beschreibung |
|---|
| hSteamPipe | HSteamPipe | Die Verbindungspipe, mit der verbunden werden soll. |
Stellt Verbindung zu einem existierenden globalen Benutzer her und schlägt fehl, wenn keiner existiert.
Wird vom Spiel zur Koordinierung mit der Steam-Bernutzeroberfläche verwendet.
NICHT THREADSICHER – Stellen Sie sicher, dass bei einem Aufruf keine anderen Threads auf die Steamworks-API zugreifen!
Rückgabe: HSteamUserDer HSteamUser-Handle des globalen Benutzers. Gibt 0 zurück, wenn es fehlschlägt, weil die Pipe ungültig oder kein globaler Benutzer vorhanden ist.
CreateLocalUser
HSteamUser CreateLocalUser( HSteamPipe *phSteamPipe, EAccountType eAccountType );
Erstellen Sie einen Steam-Benutzer, der mit niemand anderem geteilt wird. Wird nur von Spielservern verwendet.
NICHT THREADSICHER – Stellen Sie sicher, dass bei einem Aufruf keine anderen Threads auf die Steamworks-API zugreifen!
Rückgabe: HSteamUserEin neues Handle für einen SteamUser.
CreateSteamPipe
HSteamPipe CreateSteamPipe();
Erstellt eine Kommunikationspipe zum Steam-Client.
NICHT THREADSICHER – Stellen Sie sicher, dass bei einem Aufruf keine anderen Threads auf die Steamworks-API zugreifen!
Rückgabe: HSteamPipeGetIPCCallCount
uint32 GetIPCCallCount();
Gibt die Anzahl von IPC (Inter-Process Communication)-Aufrufen zurück, die seit dem letzten Aufruf dieser Funktion durchgeführt wurden.
Wird zum Debuggen der Performance verwendet, damit Sie erkennen können, wie viele IPC-Aufrufe (Inter-Process Communication) Ihr Spiel pro Frame durchführt. Jeder IPC-Aufruf ist mindestens ein Thread-Kontext-Switch oder sogar ein Prozess-Switch, sodass Sie genau steuern sollten, wie oft Sie diese Aufrufe einsetzen.
Rückgabe: uint32GetISteamApps
ISteamApps * GetISteamApps( HSteamUser hSteamUser, HSteamPipe hSteamPipe, const char *pchVersion );
| Name | Typ | Beschreibung |
|---|
| hSteamUser | HSteamUser | Der Benutzer-Handle, von dem die Schnittstelle abgerufen werden soll. |
| hSteamPipe | HSteamPipe | Die Pipe, über die auf die Schnittstelle zugegriffen werden soll. |
| pchVersion | const char * | Der Versionsstring, der die erhaltene Schnittstellenversion identifiziert. |
Ruft die mit dem angegebenen Benutzerhandle verknüpfte
ISteamApps-Schnittstelle ab.
Die folgende Konstante enthält die aktuelle Schnittstellenversion: „STEAMAPPS_INTERFACE_VERSION“
Unter normalen Umständen sollten Sie dies nie verwenden müssen. Die Funktionsweise entspricht in der Regel einem Aufruf des globalen Akzessors:
SteamApps().
Rückgabe: ISteamApps *
Ein Zeiger zur mit dem angegebenen HSteamUser verknüpften Implementierung von SteamApps.
Gibt NULL zurück, wenn eines oder mehrere der Argumente nicht gültig sind.
GetISteamController
ISteamController * GetISteamController( HSteamUser hSteamUser, HSteamPipe hSteamPipe, const char *pchVersion );
| Name | Typ | Beschreibung |
|---|
| hSteamUser | HSteamUser | Der Benutzer-Handle, von dem die Schnittstelle abgerufen werden soll. |
| hSteamPipe | HSteamPipe | Die Pipe, über die auf die Schnittstelle zugegriffen werden soll. |
| pchVersion | const char * | Der Versionsstring, der die erhaltene Schnittstellenversion identifiziert. |
Ruft die mit dem angegebenen Benutzerhandle verknüpfte
ISteamController-Schnittstelle ab.
Die folgende Konstante enthält die aktuelle Schnittstellenversion: „STEAMCONTROLLER_INTERFACE_VERSION“
Unter normalen Umständen sollten Sie dies nie verwenden müssen. Die Funktionsweise entspricht in der Regel einem Aufruf des globalen Akzessors:
SteamController().
Rückgabe: ISteamController *
Ein Zeiger zur mit dem angegebenen HSteamUser verknüpften Implementierung von SteamController.
Gibt NULL zurück, wenn eines oder mehrere der Argumente nicht gültig sind.
GetISteamFriends
ISteamFriends * GetISteamFriends( HSteamUser hSteamUser, HSteamPipe hSteamPipe, const char *pchVersion );
| Name | Typ | Beschreibung |
|---|
| hSteamUser | HSteamUser | Der Benutzer-Handle, von dem die Schnittstelle abgerufen werden soll. |
| hSteamPipe | HSteamPipe | Die Pipe, über die auf die Schnittstelle zugegriffen werden soll. |
| pchVersion | const char * | Der Versionsstring, der die erhaltene Schnittstellenversion identifiziert. |
Ruft die mit dem angegebenen Benutzerhandle verknüpfte
ISteamFriends-Schnittstelle ab.
Die folgende Konstante enthält die aktuelle Schnittstellenversion: „STEAMFRIENDS_INTERFACE_VERSION“
Unter normalen Umständen sollten Sie dies nie verwenden müssen. Die Funktionsweise entspricht in der Regel einem Aufruf des globalen Akzessors:
SteamFriends().
Rückgabe: ISteamFriends *
Ein Zeiger zur mit dem angegebenen HSteamUser verknüpften Implementierung von SteamFriends.
Gibt NULL zurück, wenn eines oder mehrere der Argumente nicht gültig sind.
GetISteamGameServer
ISteamGameServer * GetISteamGameServer( HSteamUser hSteamUser, HSteamPipe hSteamPipe, const char *pchVersion );
| Name | Typ | Beschreibung |
|---|
| hSteamUser | HSteamUser | Der Benutzer-Handle, von dem die Schnittstelle abgerufen werden soll. |
| hSteamPipe | HSteamPipe | Die Pipe, über die auf die Schnittstelle zugegriffen werden soll. |
| pchVersion | const char * | Der Versionsstring, der die erhaltene Schnittstellenversion identifiziert. |
Ruft die mit dem angegebenen Benutzerhandle verknüpfte
ISteamGameServer-Schnittstelle ab.
Die folgende Konstante enthält die aktuelle Schnittstellenversion: „STEAMGAMESERVER_INTERFACE_VERSION“
Unter normalen Umständen sollten Sie dies nie verwenden müssen. Die Funktionsweise entspricht in der Regel einem Aufruf des globalen Akzessors:
SteamGameServer().
Rückgabe: ISteamGameServer *
Ein Zeiger zur mit dem angegebenen HSteamUser verknüpften Implementierung von SteamGameServer.
Gibt NULL zurück, wenn eines oder mehrere der Argumente nicht gültig sind.
GetISteamGameServerStats
ISteamGameServerStats * GetISteamGameServerStats( HSteamUser hSteamUser, HSteamPipe hSteamPipe, const char *pchVersion );
| Name | Typ | Beschreibung |
|---|
| hSteamUser | HSteamUser | Der Benutzer-Handle, von dem die Schnittstelle abgerufen werden soll. |
| hSteamPipe | HSteamPipe | Die Pipe, über die auf die Schnittstelle zugegriffen werden soll. |
| pchVersion | const char * | Der Versionsstring, der die erhaltene Schnittstellenversion identifiziert. |
Ruft die mit dem angegebenen Benutzerhandle verknüpfte
ISteamGameServerStats-Schnittstelle ab.
Die folgende Konstante enthält die aktuelle Schnittstellenversion: „STEAMSERVERSTATS_INTERFACE_VERSION“
Unter normalen Umständen sollten Sie dies nie verwenden müssen. Die Funktionsweise entspricht in der Regel einem Aufruf des globalen Akzessors:
SteamGameServerStats().
Rückgabe: ISteamGameServerStats *
Ein Zeiger zur mit dem angegebenen HSteamUser verknüpften Implementierung von SteamGameServerStats.
Gibt NULL zurück, wenn eines oder mehrere der Argumente nicht gültig sind.
GetISteamGenericInterface
void * GetISteamGenericInterface( HSteamUser hSteamUser, HSteamPipe hSteamPipe, const char *pchVersion );
| Name | Typ | Beschreibung |
|---|
| hSteamUser | HSteamUser | Der Benutzer-Handle, von dem die Schnittstelle abgerufen werden soll. |
| hSteamPipe | HSteamPipe | Die Pipe, über die auf die Schnittstelle zugegriffen werden soll. |
| pchVersion | const char * | Der Versionsstring, der die erhaltene Schnittstellenversion identifiziert. |
Ruft eine mit einem Benutzerhandle verknüpfte generische Schnittstelle ab.
Dies sollten Sie unter normalen Umständen nie verwenden müssen.
Rückgabe: void *
Ein Zeiger zur mit dem angegebenen HSteamUser verknüpften Schnittstelle.
Gibt NULL zurück, wenn eines oder mehrere der Argumente nicht gültig sind.
GetISteamHTMLSurface
ISteamHTMLSurface * GetISteamHTMLSurface( HSteamUser hSteamUser, HSteamPipe hSteamPipe, const char *pchVersion );
| Name | Typ | Beschreibung |
|---|
| hSteamUser | HSteamUser | Der Benutzer-Handle, von dem die Schnittstelle abgerufen werden soll. |
| hSteamPipe | HSteamPipe | Die Pipe, über die auf die Schnittstelle zugegriffen werden soll. |
| pchVersion | const char * | Der Versionsstring, der die erhaltene Schnittstellenversion identifiziert. |
Ruft die mit dem angegebenen Benutzerhandle verknüpfte
ISteamHTMLSurface-Schnittstelle ab.
Die folgende Konstante enthält die aktuelle Schnittstellenversion: „STEAMHTMLSURFACE_INTERFACE_VERSION“
Unter normalen Umständen sollten Sie dies nie verwenden müssen. Die Funktionsweise entspricht in der Regel einem Aufruf des globalen Akzessors:
SteamHTMLSurface().
Rückgabe: ISteamHTMLSurface *
Ein Zeiger zur mit dem angegebenen HSteamUser verknüpften Implementierung von SteamHTMLSurface.
Gibt NULL zurück, wenn eines oder mehrere der Argumente nicht gültig sind.
GetISteamHTTP
ISteamHTTP * GetISteamHTTP( HSteamUser hSteamUser, HSteamPipe hSteamPipe, const char *pchVersion );
| Name | Typ | Beschreibung |
|---|
| hSteamUser | HSteamUser | Der Benutzer-Handle, von dem die Schnittstelle abgerufen werden soll. |
| hSteamPipe | HSteamPipe | Die Pipe, über die auf die Schnittstelle zugegriffen werden soll. |
| pchVersion | const char * | Der Versionsstring, der die erhaltene Schnittstellenversion identifiziert. |
Ruft die mit dem angegebenen Benutzerhandle verknüpfte
ISteamHTTP-Schnittstelle ab.
Die folgende Konstante enthält die aktuelle Schnittstellenversion: „STEAMHTTP_INTERFACE_VERSION“
Unter normalen Umständen sollten Sie dies nie verwenden müssen. Die Funktionsweise entspricht in der Regel einem Aufruf des globalen Zugriffs:
SteamHTTP().
Rückgabe: ISteamHTTP *
Ein Zeiger zur mit dem angegebenen HSteamUser verknüpften Implementierung von SteamHTTP.
Gibt NULL zurück, wenn eines oder mehrere der Argumente nicht gültig sind.
GetISteamInventory
ISteamInventory * GetISteamInventory( HSteamUser hSteamUser, HSteamPipe hSteamPipe, const char *pchVersion );
| Name | Typ | Beschreibung |
|---|
| hSteamUser | HSteamUser | Der Benutzer-Handle, von dem die Schnittstelle abgerufen werden soll. |
| hSteamPipe | HSteamPipe | Die Pipe, über die auf die Schnittstelle zugegriffen werden soll. |
| pchVersion | const char * | Der Versionsstring, der die erhaltene Schnittstellenversion identifiziert. |
Ruft die mit dem angegebenen Benutzerhandle verknüpfte
ISteamInventory-Schnittstelle ab.
Die folgende Konstante enthält die aktuelle Schnittstellenversion: „STEAMINVENTORY_INTERFACE_VERSION“
Unter normalen Umständen sollten Sie dies nie verwenden müssen. Die Funktionsweise entspricht in der Regel einem Aufruf des globalen Akzessors:
SteamInventory().
Rückgabe: ISteamInventory *
Ein Zeiger zur mit dem angegebenen HSteamUser verknüpften Implementierung von SteamInventory.
Gibt NULL zurück, wenn eines oder mehrere der Argumente nicht gültig sind.
GetISteamMatchmaking
ISteamMatchmaking * GetISteamMatchmaking( HSteamUser hSteamUser, HSteamPipe hSteamPipe, const char *pchVersion );
| Name | Typ | Beschreibung |
|---|
| hSteamUser | HSteamUser | Der Benutzer-Handle, von dem die Schnittstelle abgerufen werden soll. |
| hSteamPipe | HSteamPipe | Die Pipe, über die auf die Schnittstelle zugegriffen werden soll. |
| pchVersion | const char * | Der Versionsstring, der die erhaltene Schnittstellenversion identifiziert. |
Ruft die mit dem angegebenen Benutzerhandle verknüpfte
ISteamMatchmaking-Schnittstelle ab.
Die folgende Konstante enthält die aktuelle Schnittstellenversion: „STEAMMATCHMAKING_INTERFACE_VERSION“
Unter normalen Umständen sollten Sie dies nie verwenden müssen. Die Funktionsweise entspricht in der Regel einem Aufruf des globalen Zugriffs:
SteamSpielsuche().
Rückgabe: ISteamMatchmaking *
Ein Zeiger zur mit dem angegebenen HSteamUser verknüpften Implementierung von SteamSpielsuche.
Gibt NULL zurück, wenn eines oder mehrere der Argumente nicht gültig sind.
GetISteamMatchmakingServers
ISteamMatchmakingServers * GetISteamMatchmakingServers( HSteamUser hSteamUser, HSteamPipe hSteamPipe, const char *pchVersion );
| Name | Typ | Beschreibung |
|---|
| hSteamUser | HSteamUser | Der Benutzer-Handle, von dem die Schnittstelle abgerufen werden soll. |
| hSteamPipe | HSteamPipe | Die Pipe, über die auf die Schnittstelle zugegriffen werden soll. |
| pchVersion | const char * | Der Versionsstring, der die erhaltene Schnittstellenversion identifiziert. |
Ruft die mit dem angegebenen Benutzerhandle verknüpfte
ISteamMatchmakingServers-Schnittstelle ab.
Die folgende Konstante enthält die aktuelle Schnittstellenversion: „STEAMMATCHMAKINGSERVERS_INTERFACE_VERSION“
Unter normalen Umständen sollten Sie dies nie verwenden müssen. Die Funktionsweise entspricht in der Regel einem Aufruf des globalen Akzessors:
SteamSpielsucheServers().
Rückgabe: ISteamMatchmakingServers *
Ein Zeiger zur mit dem angegebenen HSteamUser verknüpften Implementierung von SteamSpielsucheServers.
Gibt NULL zurück, wenn eines oder mehrere der Argumente nicht gültig sind.
GetISteamMusic
ISteamMusic * GetISteamMusic( HSteamUser hSteamUser, HSteamPipe hSteamPipe, const char *pchVersion );
| Name | Typ | Beschreibung |
|---|
| hSteamUser | HSteamUser | Der Benutzer-Handle, von dem die Schnittstelle abgerufen werden soll. |
| hSteamPipe | HSteamPipe | Die Pipe, über die auf die Schnittstelle zugegriffen werden soll. |
| pchVersion | const char * | Der Versionsstring, der die erhaltene Schnittstellenversion identifiziert. |
Ruft die mit dem angegebenen Benutzerhandle verknüpfte
ISteamMusic-Schnittstelle ab.
Die folgende Konstante enthält die aktuelle Schnittstellenversion: „STEAMMUSIC_INTERFACE_VERSION“
Unter normalen Umständen sollten Sie dies nie verwenden müssen. Die Funktionsweise entspricht in der Regel einem Aufruf des globalen Akzessors:
SteamMusic().
Rückgabe: ISteamMusic *
Ein Zeiger zu der mit dem angegebenen HSteamUser verknüpften Implementierung von SteamMusic.
Gibt NULL zurück, wenn eines oder mehrere der Argumente nicht gültig sind.
GetISteamMusicRemote
ISteamMusicRemote * GetISteamMusicRemote( HSteamUser hSteamUser, HSteamPipe hSteamPipe, const char *pchVersion );
| Name | Typ | Beschreibung |
|---|
| hSteamUser | HSteamUser | Der Benutzer-Handle, von dem die Schnittstelle abgerufen werden soll. |
| hSteamPipe | HSteamPipe | Die Pipe, über die auf die Schnittstelle zugegriffen werden soll. |
| pchVersion | const char * | Der Versionsstring, der die erhaltene Schnittstellenversion identifiziert. |
Ruft die mit dem angegebenen Benutzerhandle verknüpfte
ISteamMusicRemote-Schnittstelle ab.
Die folgende Konstante enthält die aktuelle Schnittstellenversion: „STEAMMUSICREMOTE_INTERFACE_VERSION“
Unter normalen Umständen sollten Sie dies nie verwenden müssen. Die Funktionsweise entspricht in der Regel einem Aufruf des globalen Akzessors:
SteamMusicremote().
Rückgabe: ISteamMusicRemote *
Ein Zeiger zur mit dem angegebenen HSteamUser verknüpften Implementierung von SteamMusicRemote.
Gibt NULL zurück, wenn eines oder mehrere der Argumente nicht gültig sind.
GetISteamNetworking
ISteamNetworking * GetISteamNetworking( HSteamUser hSteamUser, HSteamPipe hSteamPipe, const char *pchVersion );
| Name | Typ | Beschreibung |
|---|
| hSteamUser | HSteamUser | Der Benutzer-Handle, von dem die Schnittstelle abgerufen werden soll. |
| hSteamPipe | HSteamPipe | Die Pipe, über die auf die Schnittstelle zugegriffen werden soll. |
| pchVersion | const char * | Der Versionsstring, der die erhaltene Schnittstellenversion identifiziert. |
Ruft die mit dem angegebenen Benutzer-Handle verknüpfte
ISteamNetworking-Schnittstelle ab.
Die folgende Konstante enthält die aktuelle Schnittstellenversion: „STEAMNETWORKING_INTERFACE_VERSION“
Unter normalen Umständen sollten Sie dies nie verwenden müssen. Die Funktionsweise entspricht in der Regel einem Aufruf des globalen Akzessors:
SteamNetworking().
Rückgabe: ISteamNetworking *
Ein Zeiger zur mit dem angegebenen HSteamUser verknüpften Implementierung von SteamNetworking.
Gibt NULL zurück, wenn eines oder mehrere der Argumente nicht gültig sind.
GetISteamRemoteStorage
ISteamRemoteStorage * GetISteamRemoteStorage( HSteamUser hSteamUser, HSteamPipe hSteamPipe, const char *pchVersion );
| Name | Typ | Beschreibung |
|---|
| hSteamUser | HSteamUser | Der Benutzer-Handle, von dem die Schnittstelle abgerufen werden soll. |
| hSteamPipe | HSteamPipe | Die Pipe, über die auf die Schnittstelle zugegriffen werden soll. |
| pchVersion | const char * | Der Versionsstring, der die erhaltene Schnittstellenversion identifiziert. |
Ruft die mit dem angegebenen Benutzer-Handle verknüpfte
ISteamRemoteStorage-Schnittstelle ab.
Die folgende Konstante enthält die aktuelle Schnittstellenversion: „STEAMREMOTESTORAGE_INTERFACE_VERSION“
Unter normalen Umständen sollten Sie dies nie verwenden müssen. Die Funktionsweise entspricht in der Regel einem Aufruf des globalen Akzessors:
SteamRemoteStorage().
Rückgabe: ISteamRemoteStorage *
Ein Zeiger zur mit dem angegebenen HSteamUser verknüpften Implementierung von SteamRemoteStorage.
Gibt NULL zurück, wenn eines oder mehrere der Argumente nicht gültig sind.
GetISteamScreenshots
ISteamScreenshots * GetISteamScreenshots( HSteamUser hSteamUser, HSteamPipe hSteamPipe, const char *pchVersion );
| Name | Typ | Beschreibung |
|---|
| hSteamUser | HSteamUser | Der Benutzer-Handle, von dem die Schnittstelle abgerufen werden soll. |
| hSteamPipe | HSteamPipe | Die Pipe, über die auf die Schnittstelle zugegriffen werden soll. |
| pchVersion | const char * | Der Versionsstring, der die erhaltene Schnittstellenversion identifiziert. |
Ruft die mit dem angegebenen Benutzerhandle verknüpfte
ISteamScreenshots-Schnittstelle ab.
Die folgende Konstante enthält die aktuelle Schnittstellenversion: „STEAMSCREENSHOTS_INTERFACE_VERSION“
Unter normalen Umständen sollten Sie dies nie verwenden müssen. Die Funktionsweise entspricht in der Regel einem Aufruf des globalen Akzessors:
SteamScreenshots().
Rückgabe: ISteamScreenshots *
Ein Zeiger zu der mit dem angegebenen HSteamUser verknüpften Implementierung von SteamScreenshots.
Gibt NULL zurück, wenn eines oder mehrere der Argumente nicht gültig sind.
GetISteamUGC
ISteamUGC * GetISteamUGC( HSteamUser hSteamUser, HSteamPipe hSteamPipe, const char *pchVersion );
| Name | Typ | Beschreibung |
|---|
| hSteamUser | HSteamUser | Der Benutzer-Handle, von dem die Schnittstelle abgerufen werden soll. |
| hSteamPipe | HSteamPipe | Die Pipe, über die auf die Schnittstelle zugegriffen werden soll. |
| pchVersion | const char * | Der Versionsstring, der die erhaltene Schnittstellenversion identifiziert. |
Ruft die mit dem angegebenen Benutzerhandle verknüpfte
ISteamUGC-Schnittstelle ab.
Die folgende Konstante enthält die aktuelle Schnittstellenversion: „STEAMUGC_INTERFACE_VERSION“.
Unter normalen Umständen sollten Sie dies nie verwenden müssen. Die Funktionsweise entspricht in der Regel einem Aufruf des globalen Akzessors:
SteamUGC().
Rückgabe: ISteamUGC *
Ein Zeiger zur mit dem angegebenen HSteamUser verknüpften Implementierung von SteamUGC.
Gibt NULL zurück, wenn eines oder mehrere der Argumente nicht gültig sind.
GetISteamUnifiedMessages
ISteamUnifiedMessages * GetISteamUnifiedMessages( HSteamUser hSteamUser, HSteamPipe hSteamPipe, const char *pchVersion );
| Name | Typ | Beschreibung |
|---|
| hSteamUser | HSteamUser | Der Benutzer-Handle, von dem die Schnittstelle abgerufen werden soll. |
| hSteamPipe | HSteamPipe | Die Pipe, über die auf die Schnittstelle zugegriffen werden soll. |
| pchVersion | const char * | Der Versionsstring, der die erhaltene Schnittstellenversion identifiziert. |
Ruft die mit dem angegebenen Benutzerhandle verknüpfte
ISteamUnifiedMessages-Schnittstelle ab.
Die folgende Konstante enthält die aktuelle Schnittstellenversion: „STEAMUNIFIEDMESSAGES_INTERFACE_VERSION“
Unter normalen Umständen sollten Sie dies nie verwenden müssen. Die Funktionsweise entspricht in der Regel einem Aufruf des globalen Akzessors:
SteamUnifiedMessages().
Rückgabe: ISteamUnifiedMessages *
Ein Zeiger zu der mit dem angegebenen HSteamUser verknüpften Implementierung von SteamUnifiedMessages.
Gibt NULL zurück, wenn eines oder mehrere der Argumente nicht gültig sind.
GetISteamUser
ISteamUser * GetISteamUser( HSteamUser hSteamUser, HSteamPipe hSteamPipe, const char *pchVersion );
| Name | Typ | Beschreibung |
|---|
| hSteamUser | HSteamUser | Der Benutzer-Handle, von dem die Schnittstelle abgerufen werden soll. |
| hSteamPipe | HSteamPipe | Die Pipe, über die auf die Schnittstelle zugegriffen werden soll. |
| pchVersion | const char * | Der Versionsstring, der die erhaltene Schnittstellenversion identifiziert. |
Ruft die mit dem angegebenen Benutzerhandle verknüpfte
ISteamSteamUser-Schnittstelle ab.
Die folgende Konstante enthält die aktuelle Schnittstellenversion: „STEAMUSER_INTERFACE_VERSION“.
Unter normalen Umständen sollten Sie dies nie verwenden müssen. Die Funktionsweise entspricht in der Regel einem Aufruf des globalen Zugriffs:
SteamUser().
Rückgabe: ISteamUser *
Ein Zeiger zur mit dem angegebenen HSteamUser verknüpften Implementierung von SteamUser.
Gibt NULL zurück, wenn eines oder mehrere der Argumente nicht gültig sind.
GetISteamUserStats
ISteamUserStats * GetISteamUserStats( HSteamUser hSteamUser, HSteamPipe hSteamPipe, const char *pchVersion );
| Name | Typ | Beschreibung |
|---|
| hSteamUser | HSteamUser | Der Benutzer-Handle, von dem die Schnittstelle abgerufen werden soll. |
| hSteamPipe | HSteamPipe | Die Pipe, über die auf die Schnittstelle zugegriffen werden soll. |
| pchVersion | const char * | Der Versionsstring, der die erhaltene Schnittstellenversion identifiziert. |
Ruft die mit dem angegebenen Benutzerhandle verknüpfte
ISteamSteamUserStats-Schnittstelle ab.
Die folgende Konstante enthält die aktuelle Schnittstellenversion: „STEAMUSERSTATS_INTERFACE_VERSION“
Unter normalen Umständen sollten Sie dies nie verwenden müssen. Die Funktionsweise entspricht in der Regel einem Aufruf des globalen Zugriffs:
SteamUserStats().
Rückgabe: ISteamUserStats *
Ein Zeiger zur mit dem angegebenen HSteamUser verknüpften Implementierung von SteamUserStats.
Gibt NULL zurück, wenn eines oder mehrere der Argumente nicht gültig sind.
GetISteamUtils
ISteamUtils * GetISteamUtils( HSteamPipe hSteamPipe, const char *pchVersion );
| Name | Typ | Beschreibung |
|---|
| hSteamPipe | HSteamPipe | Die Pipe, über die auf die Schnittstelle zugegriffen werden soll. |
| pchVersion | const char * | Der Versionsstring, der die erhaltene Schnittstellenversion identifiziert. |
Ruft die mit dem angegebenen Benutzerhandle verknüpfte
ISteamUtils-Schnittstelle ab.
Die folgende Konstante enthält die aktuelle Schnittstellenversion: „STEAMUTILS_INTERFACE_VERSION“
Unter normalen Umständen sollten Sie dies nie verwenden müssen. Die Funktionsweise entspricht in der Regel einem Aufruf des globalen Zugriffs:
SteamUtils().
Rückgabe: ISteamUtils *
Ein Zeiger zur mit dem angegebenen HSteamUser verknüpften Implementierung von SteamUtils.
Gibt NULL zurück, wenn eines oder mehrere der Argumente nicht gültig sind.
GetISteamVideo
ISteamVideo * GetISteamVideo( HSteamUser hSteamUser, HSteamPipe hSteamPipe, const char *pchVersion );
| Name | Typ | Beschreibung |
|---|
| hSteamUser | HSteamUser | Der Benutzer-Handle, von dem die Schnittstelle abgerufen werden soll. |
| hSteamPipe | HSteamPipe | Die Pipe, über die auf die Schnittstelle zugegriffen werden soll. |
| pchVersion | const char * | Der Versionsstring, der die erhaltene Schnittstellenversion identifiziert. |
Ruft die mit dem angegebenen Benutzerhandle verknüpfte
ISteamVideo-Schnittstelle ab.
Die folgende Konstante enthält die aktuelle Schnittstellenversion: „STEAMVIDEO_INTERFACE_VERSION“
Unter normalen Umständen sollten Sie dies nie verwenden müssen. Die Funktionsweise entspricht in der Regel einem Aufruf des globalen Zugriffs:
SteamVideo().
Rückgabe: ISteamVideo *
Ein Zeiger zur mit dem angegebenen HSteamUser verknüpften Implementierung von SteamVideo.
Gibt NULL zurück, wenn eines oder mehrere der Argumente nicht gültig sind.
ReleaseUser
void ReleaseUser( HSteamPipe hSteamPipe, HSteamUser hUser );
| Name | Typ | Beschreibung |
|---|
| hSteamPipe | HSteamPipe | Die Verbindungspipe, über die der Benutzer entfernt werden soll. |
| hUser | HSteamUser | Der zu entfernende Benutzer. |
Entfernt einen zugewiesenen Benutzer.
NICHT THREADSICHER: Stellen Sie sicher, dass bei einem Aufruf keine anderen Threads auf die Steamworks-API zugreifen!
SetLocalIPBinding
void SetLocalIPBinding( uint32 unIP, uint16 usPort );
| Name | Typ | Beschreibung |
|---|
| unIP | uint32 | Die lokale IP-Adresse, die Sie zuweisen möchten. |
| usPort | uint16 | Der Port, den Sie zuweisen möchten. |
Legen Sie die lokale IP-Adresse und den Port fest, die Sie zuweisen möchten.
Dies muss festgelegt sein, bevor Sie
CreateLocalUser aufrufen!
SetWarningMessageHook
void SetWarningMessageHook( SteamAPIWarningMessageHook_t pFunction );
| Name | Typ | Beschreibung |
|---|
| pFunction | SteamAPIWarningMessageHook_t | Funktionszeiger zur Rückruffunktion. |
Erzeugt einen Hook für den Empfang von SteamAPI-Warnungen und -Infonachrichten in einer Rückruffunktion.
Der Funktionsprototyp muss der Definition in SteamAPIWarningMessageHook_t entsprechen. Dies schließt auch die externe „C“-Verknüpfung und die Anrufkonvention „__cdecl“ ein.
„int nSeverity“ ist der Schweregrad: „0“ für Nachricht, „1“ für Warnung. Wenn Sie diesen Aufruf über einen Debugger ausführen, werden nur Warnungen gesendet. Wenn Sie der Befehlszeile „-debug_steamapi“ hinzufügen, werden auch Infonachrichten gesendet.
„const char * pchDebugText“ ist der Text der Nachricht.
Rückrufe werden direkt nach Aufruf der API-Funktion, die die Nachricht oder Warnung generiert, durchgeführt.
Die Übergabe von NULL entfernt den Hook.
Beispiel:extern "C" void __cdecl SteamAPIDebugTextHook( int nSeverity, const char *pchDebugText )
{
::OutputDebugString( pchDebugText );
if ( nSeverity >= 1 )
{
// Platz zur Einrichtung eines Haltepunkts zum Abfangen von API-Fehlern
int x = 3;
x = x;
}
}
void EnableWarningMessageHook()
{
SteamUtils()->SetWarningMessageHook( &SteamAPIDebugTextHook );
}
Typdefinitionen
Dies sind Typdefinitionen, die zur Verwendung mit ISteamClient definiert sind.
| Name | Basistyp | Beschreibung |
|---|
| HSteamPipe | int32 | Handle zu einer Kommunikationspipe zum Steam-Client. |
| HSteamUser | int32 | Handle zu einer einzelnen Instanz eines Steam-Benutzers. |
