Interface permettant de créer une nouvelle instance de Steam ou de se connecter à une instance de Steam existante, que ce soit dans un nouveau processus ou en local.
Dans la plupart des cas, tout est géré automatiquement via
SteamAPI_Init.
Vous n'aurez à utiliser ces API que si vous avez un plan de suivi de l'évolution des versions plus complexe ou si vous voulez implémenter un serveur de jeu multiplexé où un seul processus gère plusieurs parties en même temps avec des SteamID de serveurs de jeu indépendants.
Fonctions membres
Les fonctions membres de
ISteamClient
sont appelées par le biais de la fonction d'accesseur global
SteamClient()
.
BReleaseSteamPipe
bool BReleaseSteamPipe( HSteamPipe hSteamPipe );
Nom | Type | Description |
hSteamPipe | HSteamPipe | Le conduit à libérer. |
Libère un conduit de communication préalablement créé.
NON THREAD-SAFE - Assurez-vous qu'aucun autre thread n'accède à l'API Steamworks lors de l'appel !
Éléments renvoyés : bool
true si le conduit est valide et libéré avec succès. Sinon,
false est renvoyé.
BShutdownIfAllPipesClosed
bool BShutdownIfAllPipesClosed();
Déclenche un arrêt général de la DLL si tous les conduits sont fermés.
Éléments renvoyés : bool
ConnectToGlobalUser
HSteamUser ConnectToGlobalUser( HSteamPipe hSteamPipe );
Nom | Type | Description |
hSteamPipe | HSteamPipe | Conduit de connexion avec lequel se connecter. |
Se connecte à un compte utilisateur existant global, et échoue s'il n'en existe aucun.
Utilisé par le jeu pour la coordination avec SteamUI.
NON THREAD-SAFE - Assurez-vous qu'aucun autre thread n'accède à l'API Steamworks lors de l'appel !
Éléments renvoyés : HSteamUserHandle HSteamUser du compte utilisateur global. Renvoie 0 en cas d'échec, si le conduit n'est pas valide ou s'il n'y a pas de compte utilisateur global.
CreateLocalUser
HSteamUser CreateLocalUser( HSteamPipe *phSteamPipe, EAccountType eAccountType );
Créé un compte utilisateur Steam qui ne sera partagé avec personne d'autre. Utilisé uniquement par les serveurs de jeu.
NON THREAD-SAFE - Assurez-vous qu'aucun autre thread n'accède à l'API Steamworks lors de l'appel !
Éléments renvoyés : HSteamUserNouveau handle pour un compte Steam.
CreateSteamPipe
HSteamPipe CreateSteamPipe();
Crée un conduit de communication vers le client Steam.
NOT THREADSAFE : assurez-vous qu'aucun autre thread n'accède à l'API Steamworks pendant l'appel.
Éléments renvoyés : HSteamPipeGetIPCCallCount
uint32 GetIPCCallCount();
Renvoie le numéro des appels IPC (Inter-Process Communication) effectués depuis la dernière fois où cette fonction a été appelée.
Sert au débogage des performances pour que vous puissiez comprendre combien d'appels IPC sont effectués par votre jeu à chaque image. Chaque appel IPC est au minimum un commutateur de contexte de thread quand il n'est pas un commutateur de processus. Il est donc recommandé de ne pas les ignorer, mais plutôt de contrôler si possible le rythme auquel vous les effectuez.
Éléments renvoyés : uint32GetISteamApps
ISteamApps * GetISteamApps( HSteamUser hSteamUser, HSteamPipe hSteamPipe, const char *pchVersion );
Nom | Type | Description |
hSteamUser | HSteamUser | Handle utilisateur à partir duquel l'interface est obtenue. |
hSteamPipe | HSteamPipe | Conduit à travers lequel vous accédez à l'interface. |
pchVersion | const char * | Chaine de version qui identifie la version de l'interface que vous recevez. |
Récupère l'interface
ISteamApps associée au handle utilisateur spécifié.
Une constante contenant la version actuelle de la version de l'interface est : « STEAMAPPS_INTERFACE_VERSION ».
En conditions normales, vous n'aurez jamais à l'utiliser. Elle est équivalente en fonctionnalité à l'appel de l'accesseur global :
SteamApps()
.
Éléments renvoyés : ISteamApps *
Un pointeur vers l'implémentation de SteamApps associé au HSteamUser donné.
Renvoie NULL si l'un des arguments n'est pas valide.
GetISteamController
ISteamController * GetISteamController( HSteamUser hSteamUser, HSteamPipe hSteamPipe, const char *pchVersion );
Nom | Type | Description |
hSteamUser | HSteamUser | Handle utilisateur à partir duquel l'interface est obtenue. |
hSteamPipe | HSteamPipe | Conduit à travers lequel vous accédez à l'interface. |
pchVersion | const char * | Chaine de version qui identifie la version de l'interface que vous recevez. |
Récupère l'interface
ISteamController associée au handle utilisateur spécifié.
Une constante contenant la version actuelle de la version de l'interface est : « STEAMCONTROLLER_INTERFACE_VERSION ».
En conditions normales, vous n'aurez jamais à l'utiliser. Elle est équivalente en fonctionnalité à l'appel de l'accesseur global :
SteamController()
.
Éléments renvoyés : ISteamController *
Un pointeur vers l'implémentation de SteamController associé au HSteamUser donné.
Renvoie NULL si l'un des arguments n'est pas valide.
GetISteamFriends
ISteamFriends * GetISteamFriends( HSteamUser hSteamUser, HSteamPipe hSteamPipe, const char *pchVersion );
Nom | Type | Description |
hSteamUser | HSteamUser | Handle utilisateur à partir duquel l'interface est obtenue. |
hSteamPipe | HSteamPipe | Conduit à travers lequel vous accédez à l'interface. |
pchVersion | const char * | Chaine de version qui identifie la version de l'interface que vous recevez. |
Récupère l'interface
ISteamFriends associée au handle utilisateur spécifié.
Une constante contenant la version actuelle de la version de l'interface est : « STEAMFRIENDS_INTERFACE_VERSION ».
En conditions normales, vous n'aurez jamais à l'utiliser. Elle est équivalente en fonctionnalité à l'appel de l'accesseur global :
SteamFriends()
.
Éléments renvoyés : ISteamFriends *
Un pointeur vers l'implémentation de SteamFriends associé au HSteamUser donné.
Renvoie NULL si l'un des arguments n'est pas valide.
GetISteamGameServer
ISteamGameServer * GetISteamGameServer( HSteamUser hSteamUser, HSteamPipe hSteamPipe, const char *pchVersion );
Nom | Type | Description |
hSteamUser | HSteamUser | Handle utilisateur à partir duquel l'interface est obtenue. |
hSteamPipe | HSteamPipe | Conduit à travers lequel vous accédez à l'interface. |
pchVersion | const char * | Chaine de version qui identifie la version de l'interface que vous recevez. |
Récupère l'interface
ISteamGameServer associée au handle utilisateur spécifié.
Une constante contenant la version actuelle de la version de l'interface est : « STEAMGAMESERVER_INTERFACE_VERSION ».
En conditions normales, vous n'aurez jamais à l'utiliser. Elle est équivalente en fonctionnalité à l'appel de l'accesseur global :
SteamGameServer()
.
Éléments renvoyés : ISteamGameServer *
Un pointeur vers l'implémentation de SteamGameServer associé au HSteamUser donné.
Renvoie NULL si l'un des arguments n'est pas valide.
GetISteamGameServerStats
ISteamGameServerStats * GetISteamGameServerStats( HSteamUser hSteamUser, HSteamPipe hSteamPipe, const char *pchVersion );
Nom | Type | Description |
hSteamUser | HSteamUser | Handle utilisateur à partir duquel l'interface est obtenue. |
hSteamPipe | HSteamPipe | Conduit à travers lequel vous accédez à l'interface. |
pchVersion | const char * | Chaine de version qui identifie la version de l'interface que vous recevez. |
Récupère l'interface
ISteamGameServerStats associée au handle utilisateur spécifié.
Une constante contenant la version actuelle de la version de l'interface est : « STEAMGAMESERVERSTATS_INTERFACE_VERSION ».
En conditions normales, vous n'aurez jamais à l'utiliser. Elle est équivalente en fonctionnalité à l'appel de l'accesseur global :
SteamGameServerStats()
.
Éléments renvoyés : ISteamGameServerStats *
Un pointeur vers l'implémentation de SteamGameServerStats associé au HSteamUser donné.
Renvoie NULL si l'un des arguments n'est pas valide.
GetISteamGenericInterface
void * GetISteamGenericInterface( HSteamUser hSteamUser, HSteamPipe hSteamPipe, const char *pchVersion );
Nom | Type | Description |
hSteamUser | HSteamUser | Handle utilisateur à partir duquel l'interface est obtenue. |
hSteamPipe | HSteamPipe | Conduit à travers lequel vous accédez à l'interface. |
pchVersion | const char * | Chaine de version qui identifie la version de l'interface que vous recevez. |
Récupère une interface générique associée à un handle d'utilisateur.
En conditions normales, vous n'aurez jamais à l'utiliser.
Éléments renvoyés : void *
Un pointeur vers l'implémentation d'une interface associée au HSteamUser donné.
Renvoie NULL si l'un des arguments n'est pas valide.
GetISteamHTMLSurface
ISteamHTMLSurface * GetISteamHTMLSurface( HSteamUser hSteamUser, HSteamPipe hSteamPipe, const char *pchVersion );
Nom | Type | Description |
hSteamUser | HSteamUser | Handle utilisateur à partir duquel l'interface est obtenue. |
hSteamPipe | HSteamPipe | Conduit à travers lequel vous accédez à l'interface. |
pchVersion | const char * | Chaine de version qui identifie la version de l'interface que vous recevez. |
Récupère l'interface
ISteamHTMLSurface associée au handle utilisateur spécifié.
Une constante contenant la version actuelle de la version de l'interface est : « STEAMHTMLSURFACE_INTERFACE_VERSION ».
En conditions normales, vous n'aurez jamais à l'utiliser. Elle est équivalente en fonctionnalité à l'appel de l'accesseur global :
SteamHTMLSurface()
.
Éléments renvoyés : ISteamHTMLSurface *
Un pointeur vers l'implémentation de SteamHTMLSurface associé au HSteamUser donné.
Renvoie NULL si l'un des arguments n'est pas valide.
GetISteamHTTP
ISteamHTTP * GetISteamHTTP( HSteamUser hSteamUser, HSteamPipe hSteamPipe, const char *pchVersion );
Nom | Type | Description |
hSteamUser | HSteamUser | Handle utilisateur à partir duquel l'interface est obtenue. |
hSteamPipe | HSteamPipe | Conduit à travers lequel vous accédez à l'interface. |
pchVersion | const char * | Chaine de version qui identifie la version de l'interface que vous recevez. |
Récupère l'interface
ISteamHTTP associée au handle utilisateur spécifié.
Une constante contenant la version actuelle de la version de l'interface est : « STEAMHTTP_INTERFACE_VERSION ».
En conditions normales, vous n'aurez jamais à l'utiliser. Elle est équivalente en fonctionnalité à l'appel de l'accesseur global :
SteamHTTP()
.
Éléments renvoyés : ISteamHTTP *
Un pointeur vers l'implémentation de SteamHTTP associé au HSteamUser donné.
Renvoie NULL si l'un des arguments n'est pas valide.
GetISteamInventory
ISteamInventory * GetISteamInventory( HSteamUser hSteamUser, HSteamPipe hSteamPipe, const char *pchVersion );
Nom | Type | Description |
hSteamUser | HSteamUser | Handle utilisateur à partir duquel l'interface est obtenue. |
hSteamPipe | HSteamPipe | Conduit à travers lequel vous accédez à l'interface. |
pchVersion | const char * | Chaine de version qui identifie la version de l'interface que vous recevez. |
Récupère l'interface
ISteamInventory associée au handle utilisateur spécifié.
Une constante contenant la version actuelle de la version de l'interface est : « STEAMINVENTORY_INTERFACE_VERSION ».
En conditions normales, vous n'aurez jamais à l'utiliser. Elle est équivalente en fonctionnalité à l'appel de l'accesseur global :
SteamInventory()
.
Éléments renvoyés : ISteamInventory *
Un pointeur vers l'implémentation de SteamInventory associé au HSteamUser donné.
Renvoie NULL si l'un des arguments n'est pas valide.
GetISteamMatchmaking
ISteamMatchmaking * GetISteamMatchmaking( HSteamUser hSteamUser, HSteamPipe hSteamPipe, const char *pchVersion );
Nom | Type | Description |
hSteamUser | HSteamUser | Handle utilisateur à partir duquel l'interface est obtenue. |
hSteamPipe | HSteamPipe | Conduit à travers lequel vous accédez à l'interface. |
pchVersion | const char * | Chaine de version qui identifie la version de l'interface que vous recevez. |
Récupère l'interface
ISteamMatchmaking associée au handle utilisateur spécifié.
Une constante contenant la version actuelle de la version de l'interface est : « STEAMMATCHMAKING_INTERFACE_VERSION »
En conditions normales, vous n'aurez jamais à l'utiliser. Elle est équivalente en fonctionnalité à l'appel de l'accesseur global :
SteamMatchmaking()
.
Éléments renvoyés : ISteamMatchmaking *
Un pointeur vers l'implémentation de SteamMatchmaking associé au HSteamUser donné.
Renvoie NULL si l'un des arguments n'est pas valide.
GetISteamMatchmakingServers
ISteamMatchmakingServers * GetISteamMatchmakingServers( HSteamUser hSteamUser, HSteamPipe hSteamPipe, const char *pchVersion );
Nom | Type | Description |
hSteamUser | HSteamUser | Handle utilisateur à partir duquel l'interface est obtenue. |
hSteamPipe | HSteamPipe | Conduit à travers lequel vous accédez à l'interface. |
pchVersion | const char * | Chaine de version qui identifie la version de l'interface que vous recevez. |
Récupère l'interface
ISteamMatchmakingServers associée au handle utilisateur spécifié.
Une constante contenant la version actuelle de la version de l'interface est : « STEAMMATCHMAKINGSERVERS_INTERFACE_VERSION »
En conditions normales, vous n'aurez jamais à l'utiliser. Elle est équivalente en fonctionnalité à l'appel de l'accesseur global :
SteamMatchmakingServers()
.
Éléments renvoyés : ISteamMatchmakingServers *
Un pointeur vers l'implémentation de SteamMatchmakingServers associé au HSteamUser donné.
Renvoie NULL si l'un des arguments n'est pas valide.
GetISteamMusic
ISteamMusic * GetISteamMusic( HSteamUser hSteamUser, HSteamPipe hSteamPipe, const char *pchVersion );
Nom | Type | Description |
hSteamUser | HSteamUser | Handle utilisateur à partir duquel l'interface est obtenue. |
hSteamPipe | HSteamPipe | Conduit à travers lequel vous accédez à l'interface. |
pchVersion | const char * | Chaine de version qui identifie la version de l'interface que vous recevez. |
Récupère l'interface
ISteamMusic associée au handle utilisateur spécifié.
Une constante contenant la version actuelle de la version de l'interface est : « STEAMMUSIC_INTERFACE_VERSION ».
En conditions normales, vous n'aurez jamais à l'utiliser. Elle est équivalente en fonctionnalité à l'appel de l'accesseur global :
SteamMusic()
.
Éléments renvoyés : ISteamMusic *
Un pointeur vers l'implémentation de SteamMusic associé au HSteamUser donné.
Renvoie NULL si l'un des arguments n'est pas valide.
GetISteamMusicRemote
ISteamMusicRemote * GetISteamMusicRemote( HSteamUser hSteamUser, HSteamPipe hSteamPipe, const char *pchVersion );
Nom | Type | Description |
hSteamUser | HSteamUser | Handle utilisateur à partir duquel l'interface est obtenue. |
hSteamPipe | HSteamPipe | Conduit à travers lequel vous accédez à l'interface. |
pchVersion | const char * | Chaine de version qui identifie la version de l'interface que vous recevez. |
Récupère l'interface
ISteamMusicRemote associée au handle utilisateur spécifié.
Une constante contenant la version actuelle de la version de l'interface est : « STEAMMUSICREMOTE_INTERFACE_VERSION ».
En conditions normales, vous n'aurez jamais à l'utiliser. Elle est équivalente en fonctionnalité à l'appel de l'accesseur global :
SteamMusicRemote()
.
Éléments renvoyés : ISteamMusicRemote *
Un pointeur vers l'implémentation de SteamMusicRemote associé au HSteamUser donné.
Renvoie NULL si l'un des arguments n'est pas valide.
GetISteamNetworking
ISteamNetworking * GetISteamNetworking( HSteamUser hSteamUser, HSteamPipe hSteamPipe, const char *pchVersion );
Nom | Type | Description |
hSteamUser | HSteamUser | Handle utilisateur à partir duquel l'interface est obtenue. |
hSteamPipe | HSteamPipe | Conduit à travers lequel vous accédez à l'interface. |
pchVersion | const char * | Chaine de version qui identifie la version de l'interface que vous recevez. |
Récupère l'interface
ISteamNetworking associée au handle utilisateur spécifié.
Une constante contenant la version actuelle de la version de l'interface est : « STEAMNETWORKING_INTERFACE_VERSION »
En conditions normales, vous n'aurez jamais à l'utiliser. Elle est équivalente en fonctionnalité à l'appel de l'accesseur global :
SteamNetworking()
.
Éléments renvoyés : ISteamNetworking *
Un pointeur vers l'implémentation de SteamNetworking associé au HSteamUser donné.
Renvoie NULL si l'un des arguments n'est pas valide.
GetISteamRemoteStorage
ISteamRemoteStorage * GetISteamRemoteStorage( HSteamUser hSteamUser, HSteamPipe hSteamPipe, const char *pchVersion );
Nom | Type | Description |
hSteamUser | HSteamUser | Handle utilisateur à partir duquel l'interface est obtenue. |
hSteamPipe | HSteamPipe | Conduit à travers lequel vous accédez à l'interface. |
pchVersion | const char * | Chaine de version qui identifie la version de l'interface que vous recevez. |
Récupère l'interface
ISteamRemoteStorage associée au handle utilisateur spécifié.
Une constante contenant la version actuelle de la version de l'interface est : « STEAMREMOTESTORAGE_INTERFACE_VERSION ».
En conditions normales, vous n'aurez jamais à l'utiliser. Elle est équivalente en fonctionnalité à l'appel de l'accesseur global :
SteamRemoteStorage()
.
Éléments renvoyés : ISteamRemoteStorage *
Un pointeur vers l'implémentation de SteamRemoteStorage associé au HSteamUser donné.
Renvoie NULL si l'un des arguments n'est pas valide.
GetISteamScreenshots
ISteamScreenshots * GetISteamScreenshots( HSteamUser hSteamUser, HSteamPipe hSteamPipe, const char *pchVersion );
Nom | Type | Description |
hSteamUser | HSteamUser | Handle utilisateur à partir duquel l'interface est obtenue. |
hSteamPipe | HSteamPipe | Conduit à travers lequel vous accédez à l'interface. |
pchVersion | const char * | Chaine de version qui identifie la version de l'interface que vous recevez. |
Récupère l'interface
ISteamScreenshots associée au handle utilisateur spécifié.
Une constante contenant la version actuelle de la version de l'interface est : « STEAMSCREENSHOTS_INTERFACE_VERSION ».
En conditions normales, vous n'aurez jamais à l'utiliser. Elle est équivalente en fonctionnalité à l'appel de l'accesseur global :
SteamScreenshots()
.
Éléments renvoyés : ISteamScreenshots *
Un pointeur vers l'implémentation de SteamScreenshots associé au HSteamUser donné.
Renvoie NULL si l'un des arguments n'est pas valide.
GetISteamUGC
ISteamUGC * GetISteamUGC( HSteamUser hSteamUser, HSteamPipe hSteamPipe, const char *pchVersion );
Nom | Type | Description |
hSteamUser | HSteamUser | Handle utilisateur à partir duquel l'interface est obtenue. |
hSteamPipe | HSteamPipe | Conduit à travers lequel vous accédez à l'interface. |
pchVersion | const char * | Chaine de version qui identifie la version de l'interface que vous recevez. |
Récupère l'interface
ISteamUGC associée au handle utilisateur spécifié.
Une constante contenant la version actuelle de la version de l'interface est : « STEAMUGC_INTERFACE_VERSION ».
En conditions normales, vous n'aurez jamais à l'utiliser. Elle est équivalente en fonctionnalité à l'appel de l'accesseur global :
SteamUGC()
.
Éléments renvoyés : ISteamUGC *
Un pointeur vers l'implémentation de SteamUGC associé au HSteamUser donné.
Renvoie NULL si l'un des arguments n'est pas valide.
GetISteamUnifiedMessages
ISteamUnifiedMessages * GetISteamUnifiedMessages( HSteamUser hSteamUser, HSteamPipe hSteamPipe, const char *pchVersion );
Nom | Type | Description |
hSteamUser | HSteamUser | Handle utilisateur à partir duquel l'interface est obtenue. |
hSteamPipe | HSteamPipe | Conduit à travers lequel vous accédez à l'interface. |
pchVersion | const char * | Chaine de version qui identifie la version de l'interface que vous recevez. |
Récupère l'interface
ISteamUnifiedMessages associée au handle utilisateur spécifié.
Une constante contenant la version actuelle de la version de l'interface est : « STEAMUNIFIEDMESSAGES_INTERFACE_VERSION ».
En conditions normales, vous n'aurez jamais à l'utiliser. Elle est équivalente en fonctionnalité à l'appel de l'accesseur global :
SteamUnifiedMessages()
.
Éléments renvoyés : ISteamUnifiedMessages *
Un pointeur vers l'implémentation de SteamUnifiedMessages associé au HSteamUser donné.
Renvoie NULL si l'un des arguments n'est pas valide.
GetISteamUser
ISteamUser * GetISteamUser( HSteamUser hSteamUser, HSteamPipe hSteamPipe, const char *pchVersion );
Nom | Type | Description |
hSteamUser | HSteamUser | Handle utilisateur à partir duquel l'interface est obtenue. |
hSteamPipe | HSteamPipe | Conduit à travers lequel vous accédez à l'interface. |
pchVersion | const char * | Chaine de version qui identifie la version de l'interface que vous recevez. |
Récupère l'interface
ISteamUser associée au handle utilisateur spécifié.
Une constante contenant la version actuelle de la version de l'interface est : « STEAMUSER_INTERFACE_VERSION ».
En conditions normales, vous n'aurez jamais à l'utiliser. Elle est équivalente en fonctionnalité à l'appel de l'accesseur global :
SteamUser()
.
Éléments renvoyés : ISteamUser *
Un pointeur vers l'implémentation de SteamUser associé au HSteamUser donné.
Renvoie NULL si l'un des arguments n'est pas valide.
GetISteamUserStats
ISteamUserStats * GetISteamUserStats( HSteamUser hSteamUser, HSteamPipe hSteamPipe, const char *pchVersion );
Nom | Type | Description |
hSteamUser | HSteamUser | Handle utilisateur à partir duquel l'interface est obtenue. |
hSteamPipe | HSteamPipe | Conduit à travers lequel vous accédez à l'interface. |
pchVersion | const char * | Chaine de version qui identifie la version de l'interface que vous recevez. |
Récupère l'interface
ISteamUserStats associée au handle utilisateur spécifié.
Une constante contenant la version actuelle de la version de l'interface est : « STEAMUSERSTATS_INTERFACE_VERSION ».
En conditions normales, vous n'aurez jamais à l'utiliser. Elle est équivalente en fonctionnalité à l'appel de l'accesseur global :
SteamUserStats()
.
Éléments renvoyés : ISteamUserStats *
Un pointeur vers l'implémentation de SteamUserStats associé au HSteamUser donné.
Renvoie NULL si l'un des arguments n'est pas valide.
GetISteamUtils
ISteamUtils * GetISteamUtils( HSteamPipe hSteamPipe, const char *pchVersion );
Nom | Type | Description |
hSteamPipe | HSteamPipe | Conduit à travers lequel vous accédez à l'interface. |
pchVersion | const char * | Chaine de version qui identifie la version de l'interface que vous recevez. |
Récupère l'interface
ISteamUtils associée au handle utilisateur spécifié.
Une constante contenant la version actuelle de la version de l'interface est : « STEAMUTILS_INTERFACE_VERSION ».
En conditions normales, vous n'aurez jamais à l'utiliser. Elle est équivalente en fonctionnalité à l'appel de l'accesseur global :
SteamUtils()
.
Éléments renvoyés : ISteamUtils *
Un pointeur vers l'implémentation de SteamUtils associé au HSteamUser donné.
Renvoie NULL si l'un des arguments n'est pas valide.
GetISteamVideo
ISteamVideo * GetISteamVideo( HSteamUser hSteamUser, HSteamPipe hSteamPipe, const char *pchVersion );
Nom | Type | Description |
hSteamUser | HSteamUser | Handle utilisateur à partir duquel l'interface est obtenue. |
hSteamPipe | HSteamPipe | Conduit à travers lequel vous accédez à l'interface. |
pchVersion | const char * | Chaine de version qui identifie la version de l'interface que vous recevez. |
Récupère l'interface
ISteamVideo associée au handle utilisateur spécifié.
Une constante contenant la version actuelle de la version de l'interface est : « STEAMVIDEO_INTERFACE_VERSION ».
En conditions normales, vous n'aurez jamais à l'utiliser. Elle est équivalente en fonctionnalité à l'appel de l'accesseur global :
SteamVideo()
.
Éléments renvoyés : ISteamVideo *
Un pointeur vers l'implémentation de SteamVideo associé au HSteamUser donné.
Renvoie NULL si l'un des arguments n'est pas valide.
ReleaseUser
void ReleaseUser( HSteamPipe hSteamPipe, HSteamUser hUser );
Nom | Type | Description |
hSteamPipe | HSteamPipe | Conduit de connexion duquel supprimer le compte. |
hUser | HSteamUser | Compte à supprimer. |
Supprime un compte utilisateur alloué.
NON THREAD-SAFE - Assurez-vous qu'aucun autre thread n'accède à l'API Steamworks lors de l'appel !
SetLocalIPBinding
void SetLocalIPBinding( uint32 unIP, uint16 usPort );
Nom | Type | Description |
unIP | uint32 | Adresse IP locale à laquelle s'associer. |
usPort | uint16 | Port auquel s'associer. |
Définit l'adresse IP locale et le port auxquels s'associer.
Ces paramètres doivent être définis avant d'appeler
CreateLocalUser !
SetWarningMessageHook
void SetWarningMessageHook( SteamAPIWarningMessageHook_t pFunction );
Nom | Type | Description |
pFunction | SteamAPIWarningMessageHook_t | Pointeur de fonction vers la fonction de rappel. |
Définit un hook de message d'avertissement destiné à recevoir des messages d'avertissement et d'information de l'API Steam dans une fonction de rappel.
Le prototype de fonction doit correspondre à la définition dans SteamAPIWarningMessageHook_t. Ceci inclut le lien « extern "C" » et la convention d'appel __cdecl.
« int nSeverity » correspond à la gravité du message (0 pour un message d'information, 1 pour un message d'avertissement). En cas d'exécution depuis un débogueur, seuls les messages d'avertissement seront envoyés. Si vous ajoutez « -debug_steamapi » à la ligne de commande, les messages d'information seront aussi envoyés.
« const char * pchDebugText » est le texte du message.
Les rappels surviendront directement après l'appel de la fonction de l'API ayant généré le message d'avertissement ou d'information.
Passer NULL supprimera le hook.
Exemple :extern "C" void __cdecl SteamAPIDebugTextHook( int nSeverity, const char *pchDebugText )
{
::OutputDebugString( pchDebugText );
if ( nSeverity >= 1 )
{
// Vous pouvez définir un point d'arrêt ici pour intercepter les erreurs de l'API.
int x = 3;
x = x;
}
}
void EnableWarningMessageHook()
{
SteamUtils()->SetWarningMessageHook( &SteamAPIDebugTextHook );
}
Typedefs
Voici les typedefs destinées à être utilisées avec ISteamClient.
Nom | Type de base | Description |
HSteamPipe | int32 | Handle d'un conduit de communication vers le client Steam. |
HSteamUser | int32 | Handle vers une instance unique d'un compte Steam. |