Sisältää laajan valikoiman tietoa ja toimintoja sovelluksille ja lisämateriaaleille.

Jäsenfunktiot

ISteamApps-käyttöliittymän jäsenfunktioita kutsutaan globaalilla SteamApps()-aksessorifunktiolla.

BGetDLCDataByIndex

Nimi	Tyyppi	Kuvaus
iDLC	int	Lisämateriaalin indeksi saa arvon välillä 0 ja ISteamApps::GetDLCCount.
pAppID	AppId_t *	Palauttaa lisämateriaalin sovellustunnuksen (AppID).
pbAvailable	bool *	Palauttaa tiedon, onko lisämateriaali tällä hetkellä saatavilla Steam-kaupassa. Tämä on false, jos lisämateriaalilla ei ole näkyvää kauppasivua.
pchName	char *	Palauttaa lisämateriaalin nimen kopioimalla sen puskuriin.
cchNameBufferSize	int	Puskurin pchName pituus.

Palauttaa indeksistä lisämateriaalin metatiedot.

Paluuarvot: bool
true, jos nykyiseen sovellustunnukseen (AppID) liittyy lisämateriaali ja iDLC on välillä 0 ja ISteamApps::GetDLCCount. Muussa tapauksessa false.

Esimerkki

BIsAppInstalled

Nimi	Tyyppi	Kuvaus
appID	AppId_t	Sovelluksen sovellustunnus (AppID) tarkistettavaksi

Tarkistaa, onko tietty sovellus asennettu.

Nykyinen käyttäjä ei välttämättä omista sovellusta. Se on saattanut jäädä hänelle ilmaisviikonloppulta tms.

Toimii ainoastaan perussovelluksissa muttei lisämateriaaleissa. Käytä lisämateriaalille sen sijaan ISteamApps::BIsDlcInstalled-jäsenfunktiota.

Paluuarvot: bool
true, jos määritetty sovellustunnus (AppID) on asennettu. Muussa tapauksessa false.

BIsCybercafe

Tarkistaa, onko nykyinen sovellustunnus (AppID) Steam PC Café -käytössä.

Paluuarvot: bool
true, jos lisenssi on Steam PC Café -käytössä. Muussa tapauksessa false.
Vanhentunut, ei enää käytössä.

BIsDlcInstalled

Nimi	Tyyppi	Kuvaus
appID	AppId_t	Tarkastettavan lisämateriaalin sovellustunnus (AppID).

Tarkistaa, onko käyttäjällä tietty lisämateriaali ja onko se asennettu.

Paluuarvot: bool
true, jos käyttäjä omistaa lisämateriaalin ja se on asennettu. Muussa tapauksessa false.

Huomaa! Vain yksinkertaisia asiakasohjelman tarkistuksia varten, ei pelinsisäisten esineiden myöntämiseen.

BIsLowViolence

Tarkistaa, onko käyttäjän lisenssissä vähäisen väkivallan depotteja.

Vähäisen väkivallan depotit sopivat pelikopioille, joita myydään maissa, joissa on rajoituksia sisällölle.

Paluuarvot: bool
true, jos käyttäjän omistamassa lisenssissä on alhaisen väkivallan depotti. Muussa tapauksessa false.

Katso myös: Depottien käyttöönotto

BIsSubscribed

Tarkistaa, onko aktiivinen käyttäjä tilannut nykyisen sovellustunnuksen (AppID).

Huom! Palauttaa aina arvon true, jos käytetään Steamin DRM:ää tai kutsutaan SteamAPI_RestartAppIfNecessary.

Paluuarvot: bool
true, jos käyttäjä omistaa nykyisen sovellustunnuksen (AppID). Muussa tapauksessa false.

BIsSubscribedApp

Nimi	Tyyppi	Kuvaus
appID	apitype]steam_api::AppId_t[/apitype]	Tarkistettava sovellustunnus (AppID).

Tarkistaa, onko aktiivinen käyttäjä tilannut tietyn sovellustunnuksen.

Käytä ainoastaan, jos sinun pitää tarkistaa toisen, peliisi liittyvän sovelluksen (esimerkiksi demon) omistajuus.

Paluuarvot: bool
true, jos käyttäjä on tilannut erityisen sovellustunnuksen (AppID). Muussa tapauksessa false.

BIsSubscribedFromFamilySharing

Tarkistaa, käyttääkö aktiivinen henkilö nykyistä sovellustunnusta jonkun toisen käyttäjän väliaikaisella Lainaamo-lisenssillä.

Jos sinun on määriteltävä lisenssin vakituisen omistajan SteamID, käytä GetAppOwner.

Paluuarvot: bool
true, jos henkilö käyttää nykyistä sovellustunnusta (AppID) Lainaamon kautta. Muussa tapauksessa false.

BIsSubscribedFromFreeWeekend

Tarkistaa, onko aktiivinen käyttäjä tilannut nykyisen sovellustunnuksen (AppID) ilmaisviikonloppuna.

Ota yhteyttä Valven tekniseen yhteyspäällikköön Steamworks-keskustelupalstalla ennen käyttöä, jotta sinulla on oikea paketti ja ilmaisviikonloppu varattu.

Paluuarvot: bool
true, jos aktiiinen käyttäjä on kirjautunut nykyiseen sovellustunnukseen (AppID) ilmaisen viikonlopun kautta. Muiden lisenssityyppien tapauksessa false.

BIsTimedTrial

Nimi	Tyyppi	Kuvaus
punSecondsAllowed	uint32 *	Palauttaa ajastetun kokeilun sekuntien määrän.
punSecondsPlayed	uint32 *	Palauttaa ajastetun kokeilun tähän asti pelattujen sekuntien määrän.

Tarkistaa, onko aktiivinen käyttäjä tilannut nykyisen sovellustunnuksen (AppID) ajastetun kokeilun kautta. Jos käyttäjä on tilannut sen nykyisellä sovellustunnuksella, paluuarvo on true ja pelaamisen kokonaisajan sekä pelaajan nykyisen peliajan.

Paluuarvot: bool
true, jos aktiivinen käyttäjä on kirjautunut nykyiseen sovellustunnukseen (AppID) ajastetun kokeilun kautta. Muiden lisenssityyppien tapauksessa false.

Katso myös: ISteamApps::TimedTrialStatus_t

BIsVACBanned

Tarkistaa, onko käyttäjän tilillä VAC-kielto.

Paluuarvot: bool
true, jos käyttäjän tilillä on VAC-kielto. Muussa tapauksessa false.

GetAppBuildId

Hakee sovelluksen koontiversiotunnuksen (BuildID), joka voi vaihtua milloin tahansa palvelimen päivitysten myötä.

Paluuarvot: int
Sovelluksen tämänhetkinen koontiversiotunnus (BuildID). Jos sinulla ei ole käytössä Steamistä ladattua koontiversiota, oletuksena on 0.

GetAppInstallDir

Nimi	Tyyppi	Kuvaus
appID	AppId_t	Sovellustunnus (AppID), joka hakee asennushakemiston.
pchFolder	char *	Merkkijonopuskuri, johon kansiopolku kopioidaan.
cchFolderBufferSize	uint32	Puskurin pchFolder koko tavuissa.

Noutaa tietyn sovellustunnuksen (AppID) asennuskansion.

Toimii vaikka sovellusta ei ole asennettu, sen perusteella, mikä pelin asennuksen Steam-kirjaston oletusasennussijainti on.

Paluuarvot: uint32
Palauttaa asennushakemistopolun merkkijonona pchFolder-kansiossa toimitettuun puskuriin ja puskuriin kopioitujen tavujen lukumäärän.

GetAppOwner

Hakee nykyisen sovelluksen oikean omistajan Steam-tunnuksen. Arvo eroaa nykyisestä käyttäjästä, jos sovellus on käytössä Steamin perhekirjaston kautta.

Paluuarvot: CSteamID
Nykyisen sovelluksen alkuperäinen omistaja.

GetAvailableGameLanguages

Noutaa pilkuilla erotellun listan kielistä, joita nykyinen sovellus tukee.

Katso täydellinen lista mahdollisesti palautettavista kielistä täältä: Lokalisointi ja kielet.

Paluuarvot: const char *
Palauttaa pilkuilla erotellun listan kielistä.

Katso myös: ISteamApps::GetCurrentGameLanguage, ISteamUtils::GetSteamUILanguage

GetCurrentBetaName

Nimi	Tyyppi	Kuvaus
pchName	char *	Puskuri, jonne betanimi kopioidaan.
cchNameBufferSize	int	Puskurin pchName koko yhteensä.

Tarkistaa, onko henkilöllä betahaara käytössä ja hakee nimen, jos on.

Paluuarvot: bool
true, jos käyttäjä on betahaarassa. Muussa tapauksessa false.

GetNumBetas

Nimi	Tyyppi	Kuvaus
pnAvailable	int*	Nykyisen käyttäjän saatavilla olevien betahaarojen määrä.
pnPrivate	int*	Yksityisten betahaarojen määrä.

Palauttaa tunnettujen sovellushaarojen kokonaismäärän (mukaan lukien ns. julkinen oletushaara), joka voidaan iteroida getBetaInfo()-kutsulla.

Paluuarvot: int
Tunnettujen sovellushaarojen määrä

GetBetaInfo

Nimi	Tyyppi	Kuvaus
iBetaIndex	int	Branch index starting at 0 which is always the default branch.
punFlags	uint32 *	Nykyistä haaran tilaa kuvaava lippujen (EBetaBranchFlags) joukko.
punBuildID	uint32 *	Haarassa livenä näkyvän sisällön koontiversiotunnus.
pchBetaName	char *	Betahaaran nimi.
cchBetaName	int	Kutsujan ilmoittama pchBetaNamen koko.
pchDescription	char *	Betahaaran kuvaus.
cchDescription	int	Kutsujan ilmoittaman pchDescription-parametrin koko.

Hakee sovelluksen betahaarasta tietoja, kuten nimen, kuvauksen ja tilan.

Paluuarvot: bool
Jos haaran indeksiarvo on kelvollinen, true (tosi). Muussa tapauksessa false (epätosi).

Esimerkki:

SetActiveBeta

Nimi	Tyyppi	Kuvaus
pchBetaName	const char *	Betan nimi, johon peli haluaa vaihtaa.

Valitse sovellusta varten käytettävä betahaara. Peli pitää ehkä käynnistää uudelleen, jotta Steam voi päivittää haaran sisällön.

Paluuarvot: bool

GetCurrentGameLanguage

Hakee nykyisen, käyttäjän määrittämän kielen.

Käyttää Steam-käyttöjärjestelmän kieltä, jos käyttäjä ei ole erikseen valinnut kieltä pelille.

Täyden listan tuetuista kielistä löydät täältä: Tuetut kielet.

Paluuarvot: const char *


Katso myös: ISteamApps::GetAvailableGameLanguages, ISteamUtils::GetSteamUILanguage

GetDLCCount

Noutaa nykyisen sovelluksen lisämateriaalin osien lukumäärän.

Käytetään lisämateriaalin osioiden läpikäymiseen ja niiden tietojen hakemiseen ISteamApps::BGetDLCDataByIndex-jäsenfunktiolla.

Paluuarvot: int
Nykyisen sovelluksen lisämateriaalien määrä. Määrä voi olla enimmillään 64. Tämä riippuu lisämateriaalien määrästä, joita käyttäjä ei omista. Jos sovelluksella on useita lisämateriaaleja, kannattaa määrittää oma sisäinen lisämateriaalilista, jota vasten niitä tarkistetaan.

Esimerkki

GetDlcDownloadProgress

Nimi	Tyyppi	Kuvaus
nAppID	AppId_t	Seurattavan lisämateriaalin sovellustunnus (AppID).
punBytesDownloaded	uint64 *	Palauttaa ladattujen tavujen lukumäärän.
punBytesTotal	uint64 *	Palauttaa latauksen kokonaiskoon tavuina.

Noutaa latauksen edistymisen vaihtoehtoiselle lisämateriaalille.

Paluuarvot: bool
true, jos määritetty lisämateriaali on olemassa ja parhaillaan latauksessa. Muussa tapauksessa false.

GetEarliestPurchaseUnixTime

Nimi	Tyyppi	Kuvaus
nAppID	AppId_t	Sovellustunnus (AppID), jonka ostoajankohta haetaan.

Hakee tietyn sovelluksen ostoajan, joka ilmoitetaan Unix-ajassa (1.1.1970 lähtien).

Tämä on hyödyllinen, kun halutaan palkita käyttäjiä alkuperäisen ostopäivän perusteella.

Paluuarvot: uint32
Varhaisin ostoajankohta Unix-aikana (sekunneissa 1.1.1970 lähtien).

GetFileDetails

Nimi	Tyyppi	Kuvaus
pszFileName	const char*	Tiedoston absoluuttinen polku ja nimi.

Noutaa tiedoston metatiedot depotin luettelotiedostosta asynkronisesti.

Toimittaa tällä hetkellä:
tiedostokoon tavuina
tiedoston SHA1-hajautusalgoritmin ja
tiedoston merkinnät.

Paluuarvot: SteamAPICall_t, jota käytetään FileDetailsResult_t-takaisinkutsun tuloksena.

GetInstalledDepots

Nimi	Tyyppi	Kuvaus
appID	AppId_t	Sovellus, jonka depotit listataan.
pvecDepots	DepotId_t *	Ennalta allokoitu taulukko, joka täytetään depottilistalla.
cMaxDepots	uint32	Hankittavien depottien enimmäismäärä, tyypillisesti koko on sama kuin pvecDepots.

Noutaa sovellustunnukselle (AppID) käyttöönottojärjestyksessä kaikkien asennettujen depottien listan.

Paluuarvot: uint32
Palautettujen depottien lukumäärä.

GetLaunchCommandLine

Nimi	Tyyppi	Kuvaus
pszCommandLine	char *	Merkkijonopuskuri, johon komentorivi kopioidaan.
cubCommandLine	int	Puskurin pszCommandLine koko tavuissa.

Noutaa komentorivin, jos peli käynnistettiin Steamin URL-osoitteesta, esimerkiksi steam://run/<appid>//<command line>/. Metodia suositellaan käyttöjärjestelmän kautta tapahtuvan komentorivillä käynnistämisen sijaan, koska jälkimmäinen voi aiheuttaa turvallisuusriskin. Jotta tilapäivitys menee tämän kautta, eikä sitä laiteta käyttöliittymän komentoriville, sinun pitää ottaa Käytä käynnistyksen komentoriviä -valinta käyttöön sovelluksestasi kohdasta Asennus > Yleissivu.

Paluuarvot: int
Palauttaa komentorivin merkkijonona puskuriin, jonka on välittänyt pszCommandLine-parametri, ja palauttaa puskuriin kopioitujen tavujen lukumäärän.

Katso myös: ISteamApps::NewUrlLaunchParameters_t

GetLaunchQueryParam

Nimi	Tyyppi	Kuvaus
pchKey	const char *	Testattava julkaisutunnus. Esim. param1.

Noutaa käynnistysparametrin, jos peli on käynissä Steamissä: //run/<appid>/?param1=value1;param2=value2;param3=value3 jne.

@-merkillä alkavat parametrit on varattu sisäiseen käyttöön ja palauttavat aina tyhjän merkkijonon.
_-alaviivalla alkavat muuttujat on varattu Steam-toimintoja varten. Niitä voi kysellä pelin nimellä, mutta alaviivalla alkavia param-nimiä ei kannata käyttää omia toimintoja varten.

Paluuarvot const char *
Toimitettuun tunnukseen liittyvä arvo. Jos määritettyä tunnusta ei ole, palautetaan tyhjä merkkijono ("").

Katso myös: ISteamApps::NewLaunchQueryParameters_t

InstallDLC

Nimi	Tyyppi	Kuvaus
nAppID	AppId_t	Lisämateriaali, jonka haluat asentaa.

Sallii vaihtoehtoisen lisämateriaalin asennuksen.

Paluuarvot void

Lähettää DlcInstalled_t -takaisinkutsun.

MarkContentCorrupt

Nimi	Tyyppi	Kuvaus
bMissingFilesOnly	bool	Skannaa vain puuttuvia tiedostoja, ei vahvista jokaisen tiedoston tarkistussummia.

Pakottaa pelisisällön varmistuksen seuraavan käynnistämisen yhteydessä.

Tilanteissa, joissa peliversio on vanhentunut (jos esimerkiksi asiakasohjelma tunnistaa yhteensopivuusongelman version ja palvelimen välillä)
voit käyttää pyyntöä MarkContentCorrupt pakottaaksesi vahvistuksen, näyttää viestin käyttäjälle ja sulkea ohjelman.

Paluuarvot bool

RequestAllProofOfPurchaseKeys

Vanhentunut.

RequestAppProofOfPurchaseKey

Nimi	Tyyppi	Kuvaus
nAppID	AppId_t

Vanhentunut.

UninstallDLC

Nimi	Tyyppi	Kuvaus
nAppID	AppId_t	Lisämateriaali, jonka haluat poistaa.

Sallii valinnaisen lisämateriaalin asennuksen poistamisen.

Takaisinkutsut

Nämä ovat takaisinkutsuja, jotka käynnistetään pyynnöllä SteamAPI_RunCallbacks. Useat näistä aktivoituvat ISteamApps-jäsenfunktioiden seurauksena.

AppProofOfPurchaseKeyResponse_t

Käytetään ainoastaan sisäisesti Steamissä.

Nimi	Tyyppi	Kuvaus
m_eResult	EResult
m_nAppID	uint32
m_cchKeyLength	uint32
m_rgchKey	char［k_cubAppProofOfPurchaseKeyMax］

DlcInstalled_t

Käynnistyy, kun nykyinen käyttäjä on ostanut ja asentanut lisämateriaalin.

Nimi	Tyyppi	Kuvaus
m_nAppID	AppId_t	Asennetun lisämateriaalin sovellustunnus (AppID).

Liittyvät funktiot: ISteamApps::InstallDLC

FileDetailsResult_t

Aktivoituu tietyn tiedoston tietojen pyytämisen jälkeen.

Nimi	Tyyppi	Kuvaus
m_eResult	EResult	Onnistuiko kutsu? Jos onnistui, tulos on k_EResultOK. Muussa tapauksessa tulos on k_EResultFileNotFound, jos tiedostoa ei löydy. Jos kutsu epäonnistui, muita kenttiä ei täytetä.
m_ulFileSize	uint64	Alkuperäisen tiedoston koko tavuissa.
m_FileSHA	uint8［20］	Alkuperäisen tiedoston SHA1-hajautusalgoritmi.
m_unFlags	uint32

Liittyvät funktiot: ISteamApps::GetFileDetails

NewUrlLaunchParameters_t

Lähetetään sen jälkeen, kun käyttäjä on pelin aikana suorittanut Steam URL:n komentorivillä tai kyselyn parametreillä (esim. steam://run/<appid>//?param1=value1;param2=value2;param3=value3;). Uusia parametrejä voi kysellä ISteamApps::GetLaunchCommandLine- ja ISteamApps::GetLaunchQueryParam-jäsenfunktioilla.

Takaisinkutsussa ei ole kenttiä.

NewLaunchQueryParameters_t

Lähetetään sen jälkeen, kun käyttäjä on pelin aikana suorittanut Steam URL:n parametreillä (esim. steam://run/<appid>//?param1=value1;param2=value2;param3=value3;). Uusia parametrejä voi kysellä ISteamApps::GetLaunchQueryParam-jäsenfunktiolla.

Takaisinkutsussa ei ole kenttiä.

RegisterActivationCodeResponse_t

Käytetään ainoastaan sisäisesti Steamissä.

Nimi	Tyyppi	Kuvaus
m_eResult	ERegisterActivationCodeResult
m_unPackageRegistered	uint32

TimedTrialStatus_t

Lähetetään joka minuutti, kun sovellustunnus on omistettu ajastetun kokeilun aikana.

Nimi	Tyyppi	Kuvaus
m_unAppID	AppId_t	Ajastetun kokeilun sovellustunnus (AppID).
m_bIsOffline	bool	Jos true, käyttäjä on parhaillaan offline-tilassa. Sallittu/pelattu aika viittaa offline-aikaan, ei kokonaisaikaan.
m_unSecondsAllowed	uint32	Kuinka monta sekuntia sovellusta voi pelata yhteensä.
m_unSecondsPlayed	uint32	Kuinka monta sekuntia sovellusta on jo pelattu.

Katso myös: ISteamApps::BIsTimedTrial

Luetellut tyypit

Nämä ovat lueteltuja tyyppejä, jotka on määritetty käytettäviksi ISteamApps-käyttöliittymässä.

ERegisterActivationCodeResult

Käytetään ainoastaan sisäisesti Steamissä.

Nimi	Arvo	Kuvaus
k_ERegisterActivationCodeResultOK	0
k_ERegisterActivationCodeResultFail	1
k_ERegisterActivationCodeResultAlreadyRegistered	2
k_ERegisterActivationCodeResultTimeout	3
k_ERegisterActivationCodeAlreadyOwned	4

Vakiot

Nämä vakiot on määritetty käytettäviksi ISteamApps-käyttöliittymässä.

Nimi	Tyyppi	Arvo	Kuvaus
k_cubAppProofOfPurchaseKeyMax	int	240	Käytetään ainoastaan sisäisesti Steamissä.
STEAMAPPS_INTERFACE_VERSION	const char *	"STEAMAPPS_INTERFACE_VERSION008"