Steamworks-dokumentation
Gränssnitt – ISteamClient
Gränssnitt för att skapa en ny Steam-förekomst eller för att ansluta till en befintligt Steam-förekomst, vare sig det är i en annan process eller lokalt.

I de flesta fall hanteras detta automatiskt via SteamAPI_Init.
Du kommer bara att behöva använda dessa API:er om du har ett mer komplicerat versionsprogram eller om du vill implementera en multiplexerad spelserver med en enda process som hanterar flera spel samtidigt med oberoende spelserver-id:n på Steam.

Medlemsfunktioner

Medlemsfunktioner för ISteamClient anropas via den globala accessorfunktionen SteamClient().

BReleaseSteamPipe

bool BReleaseSteamPipe( HSteamPipe hSteamPipe );
Namn TypBeskrivning
hSteamPipeHSteamPipePipan som ska frigöras.

Frigör en tidigare skapad kommunikationspipa.

INTE TRÅDSÄKER – Se till att inga andra trådar har tillgång till Steamworks-API:et när funktionen anropas!

Returnerar: bool
true om pipan var giltig och lyckades frigöras – annars false.

BShutdownIfAllPipesClosed

bool BShutdownIfAllPipesClosed();
Utlöser global avstängning av DLL:et om alla pipor är stängda.

Returnerar: bool

ConnectToGlobalUser

HSteamUser ConnectToGlobalUser( HSteamPipe hSteamPipe );
Namn TypBeskrivning
hSteamPipeHSteamPipeAnslutningspipan som man vill ansluta till.

Ansluter till en befintlig global användare och misslyckas om det inte finns någon.

Används av spelet för att koordinera med SteamUI.

INTE TRÅDSÄKER – Se till att inga andra trådar har tillgång till Steamworks-API:et när funktionen anropas!

Returnerar: HSteamUser
Den globala användarens HSteamUser-användarreferens. Returnerar 0 vid fel om pipan är ogiltig eller om det inte finns någon global användare.

CreateLocalUser

HSteamUser CreateLocalUser( HSteamPipe *phSteamPipe, EAccountType eAccountType );
Namn TypBeskrivning
phSteamPipeHSteamPipe *
eAccountTypeEAccountType

Skapa en Steam-användare som inte delas med någon annan. Används endast av spelservrar.

INTE TRÅDSÄKER – Se till att inga andra trådar har tillgång till Steamworks-API:et när funktionen anropas!

Returnerar: HSteamUser
En ny användarreferens till en SteamUser.

CreateSteamPipe

HSteamPipe CreateSteamPipe();
Skapar en kommunikationspipa till Steam-klienten.
INTE TRÅDSÄKER – Se till att inga andra trådar har tillgång till Steamworks-API:et när funktionen anropas

Returnerar: HSteamPipe

GetIPCCallCount

uint32 GetIPCCallCount();
Returnerar antalet IPC-anrop (Inter-Process Communication) som gjorts sedan funktionen anropades sist.

Används till prestandafelsökning så att man vet hur många IPC-anrop spelet gör per bildruta. Varje IPC-anrop är minst en trådkontextväxling såvida det inte är en processväxling, så det är bra att vara grundlig och möjligtvis kontrollera hur ofta man utför dem.

Returnerar: uint32

GetISteamApps

ISteamApps * GetISteamApps( HSteamUser hSteamUser, HSteamPipe hSteamPipe, const char *pchVersion );
Namn TypBeskrivning
hSteamUserHSteamUserAnvändarreferensen som gränssnittet hämtas från.
hSteamPipeHSteamPipePipan som används för att få tillgång till gränssnittet.
pchVersionconst char *Versionssträngen som identifierar vilken version av gränssnittet som du tar emot.

Hämtar gränssnittet ISteamApps som är kopplat till den angivna användarreferensen.

En konstant som innehåller den aktuella versionen av gränssnittet är:
"STEAMAPPS_INTERFACE_VERSION"

Man ska aldrig behöva använda detta under normala förhållanden. Det är vanligtvis funktionellt likvärdigt med att anropa den globala accessorn SteamApps()

Returnerar: ISteamApps *
En pekare till implementeringen av SteamApps som är kopplat till den givna HSteamUser.

Returnerar NULL om ett eller flera av argumenten är ogiltiga.

GetISteamController

ISteamController * GetISteamController( HSteamUser hSteamUser, HSteamPipe hSteamPipe, const char *pchVersion );
NamnTypBeskrivning
hSteamUserHSteamUserAnvändarreferensen som gränssnittet hämtas från.
hSteamPipeHSteamPipePipan som används för att få tillgång till gränssnittet.
pchVersionconst char *Versionssträngen som identifierar vilken version av gränssnittet som du tar emot.

Hämtar gränssnittet ISteamController som är kopplat till den angivna användarreferensen.

En konstant som innehåller den aktuella versionen av gränssnittet är:
"STEAMCONTROLLER_INTERFACE_VERSION"

Man ska aldrig behöva använda detta under normala förhållanden. Det är vanligtvis funktionellt likvärdigt med att anropa den globala accessorn SteamController()

Returnerar: ISteamController *
En pekare till implementeringen av SteamController som är kopplat till den givna HSteamUser.

Returnerar NULL om ett eller flera av argumenten är ogiltiga.

GetISteamFriends

ISteamFriends * GetISteamFriends( HSteamUser hSteamUser, HSteamPipe hSteamPipe, const char *pchVersion );
NamnTypBeskrivning
hSteamUserHSteamUserAnvändarreferensen som gränssnittet hämtas från.
hSteamPipeHSteamPipePipan som används för att få tillgång till gränssnittet.
pchVersionconst char *Versionssträngen som identifierar vilken version av gränssnittet som du tar emot.

Hämtar gränssnittet ISteamFriends som är kopplat till den angivna användarreferensen.

En konstant som innehåller den aktuella versionen av gränssnittet är:
"STEAMFRIENDS_INTERFACE_VERSION"

Man ska aldrig behöva använda detta under normala förhållanden. Det är vanligtvis funktionellt likvärdigt med att anropa den globala accessorn SteamFriends()

Returnerar: ISteamFriends *
En pekare till implementeringen av SteamFriends som är kopplat till den givna HSteamUser.

Returnerar NULL om ett eller flera av argumenten är ogiltiga.

GetISteamGameServer

ISteamGameServer * GetISteamGameServer( HSteamUser hSteamUser, HSteamPipe hSteamPipe, const char *pchVersion );
NamnTypBeskrivning
hSteamUserHSteamUserAnvändarreferensen som gränssnittet hämtas från.
hSteamPipeHSteamPipePipan som används för att få tillgång till gränssnittet.
pchVersionconst char *Versionssträngen som identifierar vilken version av gränssnittet som du tar emot.

Hämtar gränssnittet ISteamGameServer som är kopplat till den angivna användarreferensen.

En konstant som innehåller den aktuella versionen av gränssnittet är:
"STEAMGAMESERVER_INTERFACE_VERSION"

Man ska aldrig behöva använda detta under normala förhållanden. Det är vanligtvis funktionellt likvärdigt med att anropa den globala accessorn SteamGameServer()

Returnerar: ISteamGameServer *
En pekare till implementeringen av SteamGameServer som är kopplat till den givna HSteamUser.

Returnerar NULL om ett eller flera av argumenten är ogiltiga.

GetISteamGameServerStats

ISteamGameServerStats * GetISteamGameServerStats( HSteamUser hSteamUser, HSteamPipe hSteamPipe, const char *pchVersion );
NamnTypBeskrivning
hSteamUserHSteamUserAnvändarreferensen som gränssnittet hämtas från.
hSteamPipeHSteamPipePipan som används för att få tillgång till gränssnittet.
pchVersionconst char *Versionssträngen som identifierar vilken version av gränssnittet som du tar emot.

Hämtar gränssnittet ISteamGameServerStats som är kopplat till den angivna användarreferensen.

En konstant som innehåller den aktuella versionen av gränssnittet är:
"STEAMGAMESERVERSTATS_INTERFACE_VERSION"

Man ska aldrig behöva använda detta under normala förhållanden. Det är vanligtvis funktionellt likvärdigt med att anropa den globala accessorn SteamGameServerStats()

Returnerar: ISteamGameServerStats *
En pekare till implementeringen av SteamGameServer som är kopplat till den givna HSteamUser.

Returnerar NULL om ett eller flera av argumenten är ogiltiga.

GetISteamGenericInterface

void * GetISteamGenericInterface( HSteamUser hSteamUser, HSteamPipe hSteamPipe, const char *pchVersion );
NamnTypBeskrivning
hSteamUserHSteamUserAnvändarreferensen som gränssnittet hämtas från.
hSteamPipeHSteamPipePipan som används för att få tillgång till gränssnittet.
pchVersionconst char *Versionssträngen som identifierar vilken version av gränssnittet som du tar emot.

Hämtar ett generiskt gränssnitt som är kopplat till en användarreferens.

Man ska aldrig behöva använda detta under normala förhållanden.

Returnerar: void *
En pekare till implementeringen av ett gränssnitt som är kopplat till den givna HSteamUser.

Returnerar NULL om ett eller flera av argumenten är ogiltiga.

GetISteamHTMLSurface

ISteamHTMLSurface * GetISteamHTMLSurface( HSteamUser hSteamUser, HSteamPipe hSteamPipe, const char *pchVersion );
NamnTypBeskrivning
hSteamUserHSteamUserAnvändarreferensen som gränssnittet hämtas från.
hSteamPipeHSteamPipePipan som används för att få tillgång till gränssnittet.
pchVersionconst char *Versionssträngen som identifierar vilken version av gränssnittet som du tar emot.

Hämtar gränssnittet ISteamHTMLSurface som är kopplat till den angivna användarreferensen.

En konstant som innehåller den aktuella versionen av gränssnittet är:
"STEAMHTMLSURFACE_INTERFACE_VERSION"

Man ska aldrig behöva använda detta under normala förhållanden. Det är vanligtvis funktionellt likvärdigt med att anropa den globala accessorn SteamHTMLSurface()

Returnerar: ISteamHTMLSurface *
En pekare till implementeringen av SteamHTMLSurface som är kopplat till den givna HSteamUser.

Returnerar NULL om ett eller flera av argumenten är ogiltiga.

GetISteamHTTP

ISteamHTTP * GetISteamHTTP( HSteamUser hSteamUser, HSteamPipe hSteamPipe, const char *pchVersion );
NamnTypBeskrivning
hSteamUserHSteamUserAnvändarreferensen som gränssnittet hämtas från.
hSteamPipeHSteamPipePipan som används för att få tillgång till gränssnittet.
pchVersionconst char *Versionssträngen som identifierar vilken version av gränssnittet som du tar emot.

Hämtar gränssnittet ISteamHTTP som är kopplat till den angivna användarreferensen.

En konstant som innehåller den aktuella versionen av gränssnittet är:
"STEAMHTTP_INTERFACE_VERSION"

Man ska aldrig behöva använda detta under normala förhållanden. Det är vanligtvis funktionellt likvärdigt med att anropa den globala accessorn SteamHTTP()

Returnerar: ISteamHTTP *
En pekare till implementeringen av SteamHTTP som är kopplat till den givna HSteamUser.

Returnerar NULL om ett eller flera av argumenten är ogiltiga.

GetISteamInventory

ISteamInventory * GetISteamInventory( HSteamUser hSteamUser, HSteamPipe hSteamPipe, const char *pchVersion );
NamnTypBeskrivning
hSteamUserHSteamUserAnvändarreferensen som gränssnittet hämtas från.
hSteamPipeHSteamPipePipan som används för att få tillgång till gränssnittet.
pchVersionconst char *Versionssträngen som identifierar vilken version av gränssnittet som du tar emot.

Hämtar gränssnittet ISteamInventory som är kopplat till den angivna användarreferensen.

En konstant som innehåller den aktuella versionen av gränssnittet är:
"STEAMINVENTORY_INTERFACE_VERSION"

Man ska aldrig behöva använda detta under normala förhållanden. Det är vanligtvis funktionellt likvärdigt med att anropa den globala accessorn SteamInventory()

Returnerar: ISteamInventory *
En pekare till implementeringen av SteamInventory som är kopplat till den givna HSteamUser.

Returnerar NULL om ett eller flera av argumenten är ogiltiga.

GetISteamMatchmaking

ISteamMatchmaking * GetISteamMatchmaking( HSteamUser hSteamUser, HSteamPipe hSteamPipe, const char *pchVersion );
NamnTypBeskrivning
hSteamUserHSteamUserAnvändarreferensen som gränssnittet hämtas från.
hSteamPipeHSteamPipePipan som används för att få tillgång till gränssnittet.
pchVersionconst char *Versionssträngen som identifierar vilken version av gränssnittet som du tar emot.

Hämtar gränssnittet ISteamMatchmaking som är kopplat till den angivna användarreferensen.

En konstant som innehåller den aktuella versionen av gränssnittet är:
"STEAMMATCHMAKING_INTERFACE_VERSION"

Man ska aldrig behöva använda detta under normala förhållanden. Det är vanligtvis funktionellt likvärdigt med att anropa den globala accessorn SteamMatchmaking()

Returnerar: ISteamMatchmaking *
En pekare till implementeringen av SteamMatchmaking som är kopplat till den givna HSteamUser.

Returnerar NULL om ett eller flera av argumenten är ogiltiga.

GetISteamMatchmakingServers

ISteamMatchmakingServers * GetISteamMatchmakingServers( HSteamUser hSteamUser, HSteamPipe hSteamPipe, const char *pchVersion );
NamnTypBeskrivning
hSteamUserHSteamUserAnvändarreferensen som gränssnittet hämtas från.
hSteamPipeHSteamPipePipan som används för att få tillgång till gränssnittet.
pchVersionconst char *Versionssträngen som identifierar vilken version av gränssnittet som du tar emot.

Hämtar gränssnittet ISteamMatchmakingServers som är kopplat till den angivna användarreferensen.

En konstant som innehåller den aktuella versionen av gränssnittet är:
"STEAMHMATCHMAKINGSERVERS_INTERFACE_VERSION"

Man ska aldrig behöva använda detta under normala förhållanden. Det är vanligtvis funktionellt likvärdigt med att anropa den globala accessorn SteamMatchmakingServers()

Returnerar: ISteamMatchmakingServers *
En pekare till implementeringen av SteamMatchmakingServers som är kopplat till den givna HSteamUser.

Returnerar NULL om ett eller flera av argumenten är ogiltiga.

GetISteamMusic

ISteamMusic * GetISteamMusic( HSteamUser hSteamUser, HSteamPipe hSteamPipe, const char *pchVersion );
Namn TypBeskrivning
hSteamUserHSteamUserAnvändarreferensen som gränssnittet hämtas från.
hSteamPipeHSteamPipePipan som används för att få tillgång till gränssnittet.
pchVersionconst char *Versionssträngen som identifierar vilken version av gränssnittet som du tar emot.

Hämtar gränssnittet ISteamMusic som är kopplat till den angivna användarreferensen.

En konstant som innehåller den aktuella versionen av gränssnittet är:
"STEAMMUSIC_INTERFACE_VERSION"

Man ska aldrig behöva använda detta under normala förhållanden. Det är vanligtvis funktionellt likvärdigt med att anropa den globala accessorn SteamMusic()

Returnerar: ISteamMusic *
En pekare till implementeringen av SteamMusic som är kopplat till den givna HSteamUser.

Returnerar NULL om ett eller flera av argumenten är ogiltiga.

GetISteamMusicRemote

ISteamMusicRemote * GetISteamMusicRemote( HSteamUser hSteamUser, HSteamPipe hSteamPipe, const char *pchVersion );
Namn TypBeskrivning
hSteamUserHSteamUserAnvändarreferensen som gränssnittet hämtas från.
hSteamPipeHSteamPipePipan som används för att få tillgång till gränssnittet.
pchVersionconst char *Versionssträngen som identifierar vilken version av gränssnittet som du tar emot.

Hämtar gränssnittet ISteamMusicRemote som är kopplat till den angivna användarreferensen.

En konstant som innehåller den aktuella versionen av gränssnittet är:
"STEAMMUSICREMOTE_INTERFACE_VERSION"

Man ska aldrig behöva använda detta under normala förhållanden. Det är vanligtvis funktionellt likvärdigt med att anropa den globala accessorn SteamMusicRemote()

Returnerar: ISteamMusicRemote *
En pekare till implementeringen av SteamMusicRemote som är kopplat till den givna HSteamUser.

Returnerar NULL om ett eller flera av argumenten är ogiltiga.

GetISteamNetworking

ISteamNetworking * GetISteamNetworking( HSteamUser hSteamUser, HSteamPipe hSteamPipe, const char *pchVersion );
Namn TypBeskrivning
hSteamUserHSteamUserAnvändarreferensen som gränssnittet hämtas från.
hSteamPipeHSteamPipePipan som används för att få tillgång till gränssnittet.
pchVersionconst char *Versionssträngen som identifierar vilken version av gränssnittet som du tar emot.

Hämtar gränssnittet ISteamNetworking som är kopplat till den angivna användarreferensen.

En konstant som innehåller den aktuella versionen av gränssnittet är:
"STEAMNETWORKING_INTERFACE_VERSION"

Man ska aldrig behöva använda detta under normala förhållanden. Det är vanligtvis funktionellt likvärdigt med att anropa den globala accessorn SteamNetworking()

Returnerar: ISteamNetworking *
En pekare till implementeringen av SteamNetworking som är kopplat till den givna HSteamUser.

Returnerar NULL om ett eller flera av argumenten är ogiltiga.

GetISteamRemoteStorage

ISteamRemoteStorage * GetISteamRemoteStorage( HSteamUser hSteamUser, HSteamPipe hSteamPipe, const char *pchVersion );
Namn TypBeskrivning
hSteamUserHSteamUserAnvändarreferensen som gränssnittet hämtas från.
hSteamPipeHSteamPipeKanalen som används för att få tillgång till gränssnittet.
pchVersionconst char *Versionssträngen som identifierar vilken version av gränssnittet som du tar emot.

Hämtar gränssnittet ISteamRemoteStorage som är kopplat till den angivna användarreferensen.

En konstant som innehåller den aktuella versionen av gränssnittet är:
"STEAMREMOTESTORAGE_INTERFACE_VERSION"

Man ska aldrig behöva använda detta under normala förhållanden. Det är vanligtvis funktionellt likvärdigt med att anropa den globala accessorn SteamRemoteStorage()

Returnerar: ISteamRemoteStorage *
En pekare till implementeringen av SteamRemoteStorage som är kopplat till den givna HSteamUser.

Returnerar NULL om ett eller flera av argumenten är ogiltiga.

GetISteamScreenshots

ISteamScreenshots * GetISteamScreenshots( HSteamUser hSteamUser, HSteamPipe hSteamPipe, const char *pchVersion );
Namn TypBeskrivning
hSteamUserHSteamUserAnvändarreferensen som gränssnittet hämtas från.
hSteamPipeHSteamPipePipan som används för att få tillgång till gränssnittet.
pchVersionconst char *Versionssträngen som identifierar vilken version av gränssnittet som du tar emot.

Hämtar gränssnittet ISteamScreenshots som är kopplat till den angivna användarreferensen.

En konstant som innehåller den aktuella versionen av gränssnittet är:
"STEAMSCREENSHOTS_INTERFACE_VERSION"

Man ska aldrig behöva använda detta under normala förhållanden. Det är vanligtvis funktionellt likvärdigt med att anropa den globala accessorn SteamScreenshots()

Returnerar: ISteamScreenshots *
En pekare till implementeringen av SteamScreenshots som är kopplat till den givna HSteamUser.

Returnerar NULL om ett eller flera av argumenten är ogiltiga.

GetISteamUGC

ISteamUGC * GetISteamUGC( HSteamUser hSteamUser, HSteamPipe hSteamPipe, const char *pchVersion );
Namn TypBeskrivning
hSteamUserHSteamUserAnvändarreferensen som gränssnittet hämtas från.
hSteamPipeHSteamPipePipan som används för att få tillgång till gränssnittet.
pchVersionconst char *Versionssträngen som identifierar vilken version av gränssnittet som du tar emot.

Hämtar gränssnittet ISteamUGC som är kopplat till den angivna användarreferensen.

En konstant som innehåller den aktuella versionen av gränssnittet är:
"STEAMUGC_INTERFACE_VERSION"

Man ska aldrig behöva använda detta under normala förhållanden. Det är vanligtvis funktionellt likvärdigt med att anropa den globala accessorn SteamUGC()

Returnerar: ISteamUGC *
En pekare till implementeringen av SteamUGC som är kopplat till den givna HSteamUser.

Returnerar NULL om ett eller flera av argumenten är ogiltiga.

GetISteamUnifiedMessages

ISteamUnifiedMessages * GetISteamUnifiedMessages( HSteamUser hSteamUser, HSteamPipe hSteamPipe, const char *pchVersion );
Namn TypBeskrivning
hSteamUserHSteamUserAnvändarreferensen som gränssnittet hämtas från.
hSteamPipeHSteamPipePipan som används för att få tillgång till gränssnittet.
pchVersionconst char *Versionssträngen som identifierar vilken version av gränssnittet som du tar emot.

Hämtar gränssnittet ISteamUnifiedMessages som är kopplat till den angivna användarreferensen.

En konstant som innehåller den aktuella versionen av gränssnittet är:
"STEAMUNIFIEDMESSAGES_INTERFACE_VERSION"

Man ska aldrig behöva använda detta under normala förhållanden. Det är vanligtvis funktionellt likvärdigt med att anropa den globala accessorn SteamUnifiedMessages()

Returnerar: ISteamUnifiedMessages *
En pekare till implementeringen av SteamUnifiedMessages som är kopplat till den givna HSteamUser.

Returnerar NULL om ett eller flera av argumenten är ogiltiga.

GetISteamUser

ISteamUser * GetISteamUser( HSteamUser hSteamUser, HSteamPipe hSteamPipe, const char *pchVersion );
Namn TypBeskrivning
hSteamUserHSteamUserAnvändarreferensen som gränssnittet hämtas från.
hSteamPipeHSteamPipePipan som används för att få tillgång till gränssnittet.
pchVersionconst char *Versionssträngen som identifierar vilken version av gränssnittet som du tar emot.

Hämtar gränssnittet ISteamUser som är kopplat till den angivna användarreferensen.

En konstant som innehåller den aktuella versionen av gränssnittet är:
"STEAMUSER_INTERFACE_VERSION"

Man ska aldrig behöva använda detta under normala förhållanden. Det är vanligtvis funktionellt likvärdigt med att anropa den globala accessorn SteamUser()

Returnerar: ISteamUser *
En pekare till implementeringen av SteamUser som är kopplat till den givna HSteamUser.

Returnerar NULL om ett eller flera av argumenten är ogiltiga.

GetISteamUserStats

ISteamUserStats * GetISteamUserStats( HSteamUser hSteamUser, HSteamPipe hSteamPipe, const char *pchVersion );
Namn TypBeskrivning
hSteamUserHSteamUserAnvändarreferensen som gränssnittet hämtas från.
hSteamPipeHSteamPipePipan som används för att få tillgång till gränssnittet.
pchVersionconst char *Versionssträngen som identifierar vilken version av gränssnittet som du tar emot.

Hämtar gränssnittet ISteamUserStats som är kopplat till den angivna användarreferensen.

En konstant som innehåller den aktuella versionen av gränssnittet är:
"STEAMUSERSTATS_INTERFACE_VERSION"

Man ska aldrig behöva använda detta under normala förhållanden. Det är vanligtvis funktionellt likvärdigt med att anropa den globala accessorn SteamUserStats()

Returnerar: ISteamUserStats *
En pekare till implementeringen av SteamUserStats som är kopplat till den givna HSteamUser.

Returnerar NULL om ett eller flera av argumenten är ogiltiga.

GetISteamUtils

ISteamUtils * GetISteamUtils( HSteamPipe hSteamPipe, const char *pchVersion );
Namn TypBeskrivning
hSteamPipeHSteamPipePipan som används för att få tillgång till gränssnittet.
pchVersionconst char *Versionssträngen som identifierar vilken version av gränssnittet som du tar emot.

Hämtar gränssnittet ISteamUtils som är kopplat till den angivna användarreferensen.

En konstant som innehåller den aktuella versionen av gränssnittet är:
"STEAMUTILS_INTERFACE_VERSION"

Man ska aldrig behöva använda detta under normala förhållanden. Det är vanligtvis funktionellt likvärdigt med att anropa den globala accessorn SteamUtils()

Returnerar: ISteamUtils *
En pekare till implementeringen av SteamUtils som är kopplat till den givna HSteamUser.

Returnerar NULL om ett eller flera av argumenten är ogiltiga.

GetISteamVideo

ISteamVideo * GetISteamVideo( HSteamUser hSteamUser, HSteamPipe hSteamPipe, const char *pchVersion );
Namn TypBeskrivning
hSteamUserHSteamUserAnvändarreferensen som gränssnittet hämtas från.
hSteamPipeHSteamPipePipan som används för att få tillgång till gränssnittet.
pchVersionconst char *Versionssträngen som identifierar vilken version av gränssnittet som du tar emot.

Hämtar gränssnittet ISteamVideo som är kopplat till den angivna användarreferensen.

En konstant som innehåller den aktuella versionen av gränssnittet är:
"STEAMVIDEO_INTERFACE_VERSION"

Man ska aldrig behöva använda detta under normala förhållanden. Det är vanligtvis funktionellt likvärdigt med att anropa den globala accessorn SteamVideo()

Returnerar: ISteamVideo *
En pekare till implementeringen av SteamVideo som är kopplat till den givna HSteamUser.

Returnerar NULL om ett eller flera av argumenten är ogiltiga.

ReleaseUser

void ReleaseUser( HSteamPipe hSteamPipe, HSteamUser hUser );
Namn TypBeskrivning
hSteamPipeHSteamPipeAnslutningspipan som användaren ska avlägsnas genom.
hUserHSteamUserAnvändaren som ska tas bort.

Tar bort en tilldelad användare.

INTE TRÅDSÄKER – Se till att inga andra trådar har tillgång till Steamworks-API:et när funktionen anropas!

SetLocalIPBinding

void SetLocalIPBinding( uint32 unIP, uint16 usPort );
Namn TypBeskrivning
unIPuint32Den lokala ip-adressen som man vill binda till.
usPortuint16Porten som man vill binda till.

Ställ in den lokala ip-adressen och porten som du vill binda till.

De måste ställas in innan CreateLocalUser anropas!

SetWarningMessageHook

void SetWarningMessageHook( SteamAPIWarningMessageHook_t pFunction );
Namn TypBeskrivning
pFunctionSteamAPIWarningMessageHook_tFunktionspekaren till återanropsfunktionen.

Ställer in en varningsmeddelandehook för att ta emot Steam-API-varningar och informationsmeddelanden i en återanropsfunktion.

Funktionsprototypen måste stämma överens med definitionen i SteamAPIWarningMessageHook_t. Detta inkluderar den externa C-bindningen och anropskonventionen __cdecl.

”int nSeverity” är allvarlighetsgraden: 0 för meddelande, 1 för varning. Om man kör det genom ett felsökningsprogram skickas bara varningar. Om man lägger till -debug_steamapi på kommandoraden skickas även informationsmeddelanden.
”const char * pchDebugText” är texten i meddelandet.
Återanrop sker direkt efter att API-funktionen som genererade varningen eller meddelandet anropas.

Överföring av NULL leder till frånkoppling av hook.

Exempel:
extern "C" void __cdecl SteamAPIDebugTextHook( int nSeverity, const char *pchDebugText ) { ::OutputDebugString( pchDebugText ); if ( nSeverity >= 1 ) { // plats att ange en brytpunkt för att fånga upp API-fel int x = 3; x = x; } } void EnableWarningMessageHook() { SteamUtils()->SetWarningMessageHook( &SteamAPIDebugTextHook ); }

Typedefs

Dessa är typdefinitioner som definieras för användning med ISteamClient.

Namn BastypBeskrivning
HSteamPipeint32Referens till en kommunikationspipa till Steam-klienten.
HSteamUserint32Referens till en enda förekomst av en Steam-användare.