Интерфейс ISteamRemoteStorage (документация Steamworks)

Документация Steamworks

Интерфейс ISteamRemoteStorage

Документация Steamworks > Справочник по API Steamworks > Интерфейс ISteamRemoteStorage

Функции для чтения, записи и предоставления доступа к файлам, которые могут удалённо храниться в Steam Cloud.

Подробно они описаны в разделе «Steam Cloud».

Функции-члены

Функции-члены ISteamRemoteStorage вызываются с помощью глобальной функции доступа SteamRemoteStorage().

BeginFileWriteBatch

bool BeginFileWriteBatch( );

Use this along with EndFileWriteBatch to wrap a set of local file writes/deletes that should be considered part of one single state change. For example, if saving game progress requires updating both savegame1.dat and maxprogress.dat, wrap those operations with calls to BeginFileWriteBatch and EndFileWriteBatch.

These functions provide a hint to Steam which will help it manage the app's Cloud files. Using these functions is optional, however it will provide better reliability.

Note that the functions may be used whether the writes are done using the ISteamRemoteStorage API, or done directly to local disk (where AutoCloud is used).

Возвращает: bool
true if the write batch was begun, false if there was a batch already in progress.

CommitPublishedFileUpdate

SteamAPICall_t CommitPublishedFileUpdate( PublishedFileUpdateHandle_t updateHandle );

Название	Тип	Описание
updateHandle	PublishedFileUpdateHandle_t

Deprecated - Only used with the deprecated RemoteStorage based Workshop API.

Возвращаемые значения: SteamAPICall_t to be used with a RemoteStorageUpdatePublishedFileResult_t call result.

CreatePublishedFileUpdateRequest

PublishedFileUpdateHandle_t CreatePublishedFileUpdateRequest( PublishedFileId_t unPublishedFileId );

Название	Тип	Описание
unPublishedFileId	PublishedFileId_t

Deprecated - Only used with the deprecated RemoteStorage based Workshop API.

Возвращаемые значения: PublishedFileUpdateHandle_t

DeletePublishedFile

SteamAPICall_t DeletePublishedFile( PublishedFileId_t unPublishedFileId );

Название	Тип	Описание
unPublishedFileId	PublishedFileId_t

Deprecated - Only used with the deprecated RemoteStorage based Workshop API.

Возвращает: SteamAPICall_t to be used with a RemoteStorageDeletePublishedFileResult_t call result.

EndFileWriteBatch

bool EndFileWriteBatch( );

Use this along with BeginFileWriteBatch - see that documentation for more details.

Возвращает: bool
true, if the write batch was ended, false if there was no batch already in progress.

EnumeratePublishedFilesByUserAction

SteamAPICall_t EnumeratePublishedFilesByUserAction( EWorkshopFileAction eAction, uint32 unStartIndex );

Название	Тип	Описание
eAction	EWorkshopFileAction
unStartIndex	uint32

Deprecated - Only used with the deprecated RemoteStorage based Workshop API.

Возвращает: SteamAPICall_t to be used with a RemoteStorageEnumeratePublishedFilesByUserActionResult_t call result.

EnumeratePublishedWorkshopFiles

SteamAPICall_t EnumeratePublishedWorkshopFiles( EWorkshopEnumerationType eEnumerationType, uint32 unStartIndex, uint32 unCount, uint32 unDays, SteamParamStringArray_t *pTags, SteamParamStringArray_t *pUserTags );

Название	Тип	Описание
eEnumerationType	EWorkshopEnumerationType
unStartIndex	uint32
unCount	uint32
unDays	uint32
pTags	SteamParamStringArray_t *
pUserTags	SteamParamStringArray_t *

Deprecated - Only used with the deprecated RemoteStorage based Workshop API.

Возвращает: SteamAPICall_t to be used with a RemoteStorageEnumerateWorkshopFilesResult_t call result.

EnumerateUserPublishedFiles

SteamAPICall_t EnumerateUserPublishedFiles( uint32 unStartIndex );

Название	Тип	Описание
unStartIndex	uint32

Deprecated - Only used with the deprecated RemoteStorage based Workshop API.

Возвращает: SteamAPICall_t to be used with a RemoteStorageEnumerateUserPublishedFilesResult_t call result.

EnumerateUserSharedWorkshopFiles

SteamAPICall_t EnumerateUserSharedWorkshopFiles( CSteamID steamId, uint32 unStartIndex, SteamParamStringArray_t *pRequiredTags, SteamParamStringArray_t *pExcludedTags );

Название	Тип	Описание
steamId	CSteamID
unStartIndex	uint32
pRequiredTags	SteamParamStringArray_t *
pExcludedTags	SteamParamStringArray_t *

Deprecated - Only used with the deprecated RemoteStorage based Workshop API.

Возвращает: SteamAPICall_t to be used with a RemoteStorageEnumerateUserPublishedFilesResult_t call result.

EnumerateUserSubscribedFiles

SteamAPICall_t EnumerateUserSubscribedFiles( uint32 unStartIndex );

Название	Тип	Описание
unStartIndex	uint32

Deprecated - Only used with the deprecated RemoteStorage based Workshop API.

Returns: SteamAPICall_t to be used with a RemoteStorageEnumerateUserSubscribedFilesResult_t call result.

FileDelete

bool FileDelete( const char *pchFile );

Название	Тип	Описание
pchFile	const char *	Имя удаляемого файла.

Deletes a file from the local disk, and propagates that delete to the cloud.

This is meant to be used when a user actively deletes a file. Use FileForget if you want to remove a file from the Steam Cloud but retain it on the users local disk.

When a file has been deleted it can be re-written with FileWrite to reupload it to the Steam Cloud.

Возвращает: bool
true, if the file exists and has been successfully deleted; otherwise, false if the file did not exist.

FileExists

bool FileExists( const char *pchFile );

Название	Тип	Описание
pchFile	const char *	Имя файла.

Checks whether the specified file exists.

Возвращаемые значения: bool
true, if the file exists; otherwise, false.

FileFetch

bool FileFetch( const char *pchFile );

Название	Тип	Описание
pchFile	const char *

Deprecated - PS3 Only.

Возвращает: bool

FileForget

bool FileForget( const char *pchFile );

Название	Тип	Описание
pchFile	const char *	Имя файла, который требуется забыть.

Deletes the file from remote storage, but leaves it on the local disk and remains accessible from the API.

When you are out of Cloud space, this can be used to allow calls to FileWrite to keep working without needing to make the user delete files.

How you decide which files to forget are up to you. It could be a simple Least Recently Used (LRU) queue or something more complicated.

Requiring the user to manage their Cloud-ized files for a game, while is possible to do, it is never recommended. For instance, "Which file would you like to delete so that you may store this new one?" removes a significant advantage of using the Cloud in the first place: its transparency.

Once a file has been deleted or forgotten, calling FileWrite will resynchronize it in the Cloud. Rewriting a forgotten file is the only way to make it persisted again.

Возвращаемые значения: bool
true if the file exists and has been successfully forgotten; otherwise, false.

FilePersist

bool FilePersist( const char *pchFile );

Название	Тип	Описание
pchFile	const char *

Deprecated - PS3 Only.

Возвращаемые значения: bool

FilePersisted

bool FilePersisted( const char *pchFile );

Название	Тип	Описание
pchFile	const char *	Имя файла.

Checks if a specific file is persisted in the steam cloud.

Возвращаемые значения: bool
При успехе true, if the file exists and the file is persisted in the Steam Cloud.
false if FileForget was called on it and is only available locally.

FileRead

int32 FileRead( const char *pchFile, void *pvData, int32 cubDataToRead );

Название	Тип	Описание
pchFile	const char *	Имя прочитываемого файла.
pvData	void *	Буфер, в который копируется прочитанное. Он должен быть как минимум того же размера, который указан в `cubDataToRead`.
cubDataToRead	int32	Число прочитываемых байтов. Обычно можно получить в GetFileSize или GetFileTimestamp.

Opens a binary file, reads the contents of the file into a byte array, and then closes the file.

ВНИМАНИЕ: This is a synchronous call and as such is a will block your calling thread on the disk IO, and will also block the SteamAPI, which can cause other threads in your application to block. To avoid "hitching" due to a busy disk on the client machine using FileReadAsync, the asynchronous version of this API is recommended.

Возвращает: int32
The number of bytes read.

Returns 0 if the file doesn't exist or the read fails.

FileReadAsync

SteamAPICall_t FileReadAsync( const char *pchFile, uint32 nOffset, uint32 cubToRead );

Название	Тип	Описание
pchFile	const char *	Имя прочитываемого файла.
nOffset	uint32	Сдвиг, откуда начать чтение файла (в байтах). 0, если вы хотите прочесть файл одним фрагментом.
cubToRead	uint32	Число прочитываемых байтов, начиная с `nOffset`.

Starts an asynchronous read from a file.

The offset and amount to read should be valid for the size of the file, as indicated by GetFileSize or GetFileTimestamp.

Returns: SteamAPICall_t to be used with a RemoteStorageFileReadAsyncComplete_t call result.
Returns k_uAPICallInvalid under the following conditions:

Вы попытались прочесть недопустимый путь или имя файла. Поскольку Steam Cloud — кроссплатформенная система, у файлов должны быть действительные имена для всех поддерживаемых ОС и файловых систем. См. статью «Именование файлов, путей и пространств имен» в документации Microsoft.
Файл не существует.
cubDataToRead <= 0 байтов. Нельзя прочесть ничто!
Комбинация [[code-inline]pvData

[/code-inline] и cubDataToRead выводит за пределы файла.

У вас уже есть асинхронный вызов на чтение этого файла.

[/list]

Upon completion of the read request you will receive the call result, if the value of m_eResult within the call result is k_EResultOK you can then call FileReadAsyncComplete to read the requested data into your buffer. The hReadCall parameter should match the return value of this function, and the amount to read should generally be equal to the amount requested as indicated by m_nOffset and m_cubRead.

FileReadAsyncComplete

bool FileReadAsyncComplete( SteamAPICall_t hReadCall, void *pvBuffer, uint32 cubToRead );

Название	Тип	Описание
hReadCall	SteamAPICall_t	Дескриптор результата вызова, полученный из RemoteStorageFileReadAsyncComplete_t.
pvBuffer	void *	Буфер, в который копируется прочитанное.
cubToRead	uint32	Число копируемых байтов. Обычно это значение `m_cubRead` из RemoteStorageFileReadAsyncComplete_t.

Copies the bytes from a file which was asynchronously read with FileReadAsync into a byte array.

This should never be called outside of the context of a RemoteStorageFileReadAsyncComplete_t call result.

Возвращает: bool
true, if the file was successfully read.

Otherwise, false under the following conditions:

Дескриптор, переданный в hReadCall, недопустим.
Чтение не удалось, как отражено в m_eResult в RemoteStorageFileReadAsyncComplete_t, вам не следовало отправлять этот вызов.
Буфер в pvBuffer недостаточен.

FileShare

SteamAPICall_t FileShare( const char *pchFile );

Название	Тип	Описание
pchFile	const char *

Возвращает: SteamAPICall_t to be used with a RemoteStorageFileShareResult_t call result.

FileWrite

bool FileWrite( const char *pchFile, const void *pvData, int32 cubData );

Название	Тип	Описание
pchFile	const char *	Имя записываемого файла.
pvData	const void *	Записываемые в файл байты.
cubData	int32	Число записываемых в файл байтов. Обычно размер `pvData`.

Creates a new file, writes the bytes to the file, and then closes the file. If the target file already exists, it is overwritten.

ВНИМАНИЕ: This is a synchronous call and as such is a will block your calling thread on the disk IO, and will also block the SteamAPI, which can cause other threads in your application to block. To avoid "hitching" due to a busy disk on the client machine using FileWriteAsync, the asynchronous version of this API is recommended.

Возвращаемые значения: bool
true, if the write was successful.

Otherwise, false under the following conditions:

Размер файла, который вы пытаетесь записать, превышает 100 МиБ, что определено в k_unMaxCloudFileChunkSize.
cubData меньше, чем 0.
pvData равен NULL.
Вы попытались записать недопустимый путь или имя файла. Поскольку Steam Cloud — кроссплатформенная система, у файлов должны быть действительные имена для всех поддерживаемых ОС и файловых систем. См. статью «Именование файлов, путей и пространств имен» в документации Microsoft.
Превышен допустимый размер хранилища в Steam Cloud. У пользователя могло закончиться пространство, либо у него слишком много файлов.
Steam не удалось записать на диск, папка может быть предназначена только для чтения.

FileWriteAsync

SteamAPICall_t FileWriteAsync( const char *pchFile, const void *pvData, uint32 cubData );

Название	Тип	Описание
pchFile	const char *	Имя записываемого файла.
pvData	const void *	Записываемые в файл байты.
cubData	uint32	Число записываемых в файл байтов. Обычно размер `pvData`.

Creates a new file and asynchronously writes the raw byte data to the Steam Cloud, and then closes the file. If the target file already exists, it is overwritten.

Возвращает: SteamAPICall_t to be used with a RemoteStorageFileWriteAsyncComplete_t call result.
Returns k_uAPICallInvalid under the following conditions:

Размер файла, который вы пытаетесь записать, превышает 100 МиБ, что определено в k_unMaxCloudFileChunkSize.
cubData меньше, чем 0.
pvData равен NULL.
Вы попытались записать недопустимый путь или имя файла. Поскольку Steam Cloud — кроссплатформенная система, у файлов должны быть действительные имена для всех поддерживаемых ОС и файловых систем. См. статью «Именование файлов, путей и пространств имен» в документации Microsoft.
Превышен допустимый размер хранилища в Steam Cloud. У пользователя могло закончиться пространство, либо у него слишком много файлов.

FileWriteStreamCancel

bool FileWriteStreamCancel( UGCFileWriteStreamHandle_t writeHandle );

Название	Тип	Описание
writeHandle	UGCFileWriteStreamHandle_t	Поток записи, который требуется отменить.

Cancels a file write stream that was started by FileWriteStreamOpen.

This trashes all of the data written and closes the write stream, but if there was an existing file with this name, it remains untouched.

Возвращает: bool

FileWriteStreamClose

bool FileWriteStreamClose( UGCFileWriteStreamHandle_t writeHandle );

Название	Тип	Описание
writeHandle	UGCFileWriteStreamHandle_t	Поток записи, который требуется закрыть.

Closes a file write stream that was started by FileWriteStreamOpen.

This flushes the stream to the disk, overwriting the existing file if there was one.

Возвращает: bool
true, if the file write stream was successfully closed, the file has been committed to the disk.
false, if writeHandle is not a valid file write stream.

FileWriteStreamOpen

UGCFileWriteStreamHandle_t FileWriteStreamOpen( const char *pchFile );

Название	Тип	Описание
pchFile	const char *	Имя записываемого файла.

Creates a new file output stream allowing you to stream out data to the Steam Cloud file in chunks. If the target file already exists, it is not overwritten until FileWriteStreamClose has been called.

To write data out to this stream you can use FileWriteStreamWriteChunk, and then to close or cancel you use FileWriteStreamClose and FileWriteStreamCancel respectively.

Возвращает: UGCFileWriteStreamHandle_t
Returns k_UGCFileStreamHandleInvalid under the following conditions:

Вы попытались записать недопустимый путь или имя файла. Поскольку Steam Cloud — кроссплатформенная система, у файлов должны быть действительные имена для всех поддерживаемых ОС и файловых систем. См. статью «Именование файлов, путей и пространств имен» в документации Microsoft.
Превышен допустимый размер хранилища в Steam Cloud. У пользователя могло закончиться пространство, либо у него слишком много файлов.

FileWriteStreamWriteChunk

bool FileWriteStreamWriteChunk( UGCFileWriteStreamHandle_t writeHandle, const void *pvData, int32 cubData );

Название	Тип	Описание
writeHandle	UGCFileWriteStreamHandle_t	Поток записи файла, в который требуется записывать.
pvData	const void *	Записываемые в поток данные.
cubData	int32	Размер `pvData` в байтах.

Writes a blob of data to the file write stream.

Возвращаемые значения: bool
true, if the data was successfully written to the file write stream.
false if writeHandle is not a valid file write stream, cubData is negative or larger than k_unMaxCloudFileChunkSize, or the current user's Steam Cloud storage quota has been exceeded. They may have run out of space, or have too many files.

GetCachedUGCCount

int32 GetCachedUGCCount();

Возвращаемые значения: int32

GetCachedUGCHandle

UGCHandle_t GetCachedUGCHandle( int32 iCachedContent );

Название	Тип	Описание
iCachedContent	int32

Returns: UGCHandle_t

GetFileCount

int32 GetFileCount();

Gets the total number of local files synchronized by Steam Cloud.

Used for enumeration with GetFileNameAndSize.

Возвращает: int32
The number of files present for the current user, including files in subfolders.

GetFileListFromServer

void GetFileListFromServer();

Deprecated - PS3 Only.

GetFileNameAndSize

const char * GetFileNameAndSize( int iFile, int32 *pnFileSizeInBytes );

Название	Тип	Описание
iFile	int	Индекс файла, должен быть между 0 и GetFileCount.
pnFileSizeInBytes	int32 *	Возвращает размер файла в байтах.

Gets the file name and size of a file from the index.

ВНИМАНИЕ: You must call GetFileCount first to get the number of files.

Возвращает: const char *
The name of the file at the specified index, if it exists. Returns an empty string ("") if the file doesn't exist.

Пример:

int32 fileCount = SteamRemoteStorage()->GetFileCount(); for ( int i = 0; i < fileCount; ++i ) { int32 fileSize; const char *fileName = SteamRemoteStorage()->GetFileNameAndSize( i, &fileSize ); // Do something with fileSize and fileName }

GetFileSize

int32 GetFileSize( const char *pchFile );

Название	Тип	Описание
pchFile	const char *	Имя файла.

Gets the specified files size in bytes.

Возвращает: int32
The size of the file in bytes. Returns0 if the file does not exist.

GetFileTimestamp

int64 GetFileTimestamp( const char *pchFile );

Название	Тип	Описание
pchFile	const char *	Имя файла.

Gets the specified file's last modified timestamp in Unix epoch format (seconds since Jan 1st 1970).

Возвращает: int64
The last modified timestamp in Unix epoch format (seconds since Jan 1st 1970).

GetLocalFileChangeCount

int32 GetLocalFileChangeCount( );

Note: only applies to applications flagged as supporting dynamic Steam Cloud sync.

When your application receives a RemoteStorageLocalFileChange_t, use this method to get the number of changes (file updates and file deletes) that have been made. You can then iterate the changes using GetLocalFileChange.

Возвращает: int32
The number of local file changes that have occurred.

GetLocalFileChange

const char *GetLocalFileChange( int iFile, ERemoteStorageLocalFileChange *pEChangeType, ERemoteStorageFilePathType *pEFilePathType );

Note: only applies to applications flagged as supporting dynamic Steam Cloud sync.

After calling GetLocalFileChangeCount, use this method to iterate over the changes. The changes described have already been made to local files. Your application should take appropriate action to reload state from disk, and possibly notify the user.

For example: The local system had been suspended, during which time the user played elsewhere and uploaded changes to the Steam Cloud. On resume, Steam downloads those changes to the local system before resuming the application. The application receives an RemoteStorageLocalFileChange_t, and uses GetLocalFileChangeCount and GetLocalFileChange to iterate those changes. Depending on the application structure and the nature of the changes, the application could:

Re-load game progress to resume at exactly the point where the user was when they exited the game on the other device
Notify the user of any synchronized changes that don't require reloading
etc

Название	Тип	Описание
iFile	int32	Zero-based index of the change
pEChangeType	ERemoteStorageLocalFileChange	What happened to this file
pEFilePathType	ERemoteStorageFilePathType	Type of path to the file returned

Возвращаемые значения: const char *
The file name or full path of the file affected by this change. See comments on pEFilePathType above for more detail.

GetPublishedFileDetails

SteamAPICall_t GetPublishedFileDetails( PublishedFileId_t unPublishedFileId, uint32 unMaxSecondsOld );

Название	Тип	Описание
unPublishedFileId	PublishedFileId_t
unMaxSecondsOld	uint32

Deprecated - Only used with the deprecated RemoteStorage based Workshop API.

Возвращает: SteamAPICall_t to be used with a RemoteStorageGetPublishedFileDetailsResult_t call result.

GetPublishedItemVoteDetails

SteamAPICall_t GetPublishedItemVoteDetails( PublishedFileId_t unPublishedFileId );

Название	Тип	Описание
unPublishedFileId	PublishedFileId_t

Deprecated - Only used with the deprecated RemoteStorage based Workshop API.

Возвращает: SteamAPICall_t to be used with a RemoteStorageGetPublishedItemVoteDetailsResult_t call result.

GetQuota

bool GetQuota( uint64 *pnTotalBytes, uint64 *puAvailableBytes );

Название	Тип	Описание
pnTotalBytes	uint64 *	Returns the total amount of bytes the user has access to.
puAvailableBytes	uint64 *	Returns the number of bytes available.

Gets the number of bytes available, and used on the users Steam Cloud storage.

Возвращает: bool
This function always returns true.

GetSyncPlatforms

ERemoteStoragePlatform GetSyncPlatforms( const char *pchFile );

Название	Тип	Описание
pchFile	const char *	The name of the file.

Obtains the platforms that the specified file will syncronize to.

Возвращаемые значения: ERemoteStoragePlatform
Bitfield containing the platforms that the file was set to with SetSyncPlatforms.

GetUGCDetails

bool GetUGCDetails( UGCHandle_t hContent, AppId_t *pnAppID, char **ppchName, int32 *pnFileSizeInBytes, CSteamID *pSteamIDOwner );

Название	Тип	Описание
hContent	UGCHandle_t
pnAppID	AppId_t *
ppchName	char **
pnFileSizeInBytes	int32 *
pSteamIDOwner	CSteamID *

Возвращает: bool

GetUGCDownloadProgress

bool GetUGCDownloadProgress( UGCHandle_t hContent, int32 *pnBytesDownloaded, int32 *pnBytesExpected );

Название	Тип	Описание
hContent	UGCHandle_t
pnBytesDownloaded	int32 *
pnBytesExpected	int32 *

Возвращает: bool

GetUserPublishedItemVoteDetails

SteamAPICall_t GetUserPublishedItemVoteDetails( PublishedFileId_t unPublishedFileId );

Название	Тип	Описание
unPublishedFileId	PublishedFileId_t

Deprecated - Only used with the deprecated RemoteStorage based Workshop API.

Возвращаемые значения: SteamAPICall_t to be used with a RemoteStorageGetPublishedItemVoteDetailsResult_t call result.

IsCloudEnabledForAccount

bool IsCloudEnabledForAccount();

Checks if the account wide Steam Cloud setting is enabled for this user; or if they disabled it in the Settings->Cloud dialog.

Ensure that you are also checking IsCloudEnabledForApp, as these two options are mutually exclusive.

Возвращаемые значения: bool
true if Steam Cloud is enabled for this account; otherwise, false.

IsCloudEnabledForApp

bool IsCloudEnabledForApp();

Checks if the per game Steam Cloud setting is enabled for this user; or if they disabled it in the Game Properties->Update dialog.

Ensure that you are also checking IsCloudEnabledForAccount, as these two options are mutually exclusive.

It's generally recommended that you allow the user to toggle this setting within your in-game options, you can toggle it with SetCloudEnabledForApp.

Возвращает: bool
true, if Steam Cloud is enabled for this app; otherwise, false.

PublishVideo

SteamAPICall_t PublishVideo( EWorkshopVideoProvider eVideoProvider, const char *pchVideoAccount, const char *pchVideoIdentifier, const char *pchPreviewFile, AppId_t nConsumerAppId, const char *pchTitle, const char *pchDescription, ERemoteStoragePublishedFileVisibility eVisibility, SteamParamStringArray_t *pTags );

Название	Тип	Описание
eVideoProvider	EWorkshopVideoProvider
pchVideoAccount	const char *
pchVideoIdentifier	const char *
pchPreviewFile	const char *
nConsumerAppId	AppId_t
pchTitle	const char *
pchDescription	const char *
eVisibility	ERemoteStoragePublishedFileVisibility
pTags	SteamParamStringArray_t *

Deprecated - Only used with the deprecated RemoteStorage based Workshop API.

Возвращаемые значения: SteamAPICall_t to be used with a RemoteStoragePublishFileProgress_t call result.

PublishWorkshopFile

SteamAPICall_t PublishWorkshopFile( const char *pchFile, const char *pchPreviewFile, AppId_t nConsumerAppId, const char *pchTitle, const char *pchDescription, ERemoteStoragePublishedFileVisibility eVisibility, SteamParamStringArray_t *pTags, EWorkshopFileType eWorkshopFileType );

Название	Тип	Описание
pchFile	const char *
pchPreviewFile	const char *
nConsumerAppId	AppId_t
pchTitle	const char *
pchDescription	const char *
eVisibility	ERemoteStoragePublishedFileVisibility
pTags	SteamParamStringArray_t *
eWorkshopFileType	EWorkshopFileType

Deprecated - Only used with the deprecated RemoteStorage based Workshop API.

Возвращает: SteamAPICall_t to be used with a RemoteStoragePublishFileProgress_t call result.

ResetFileRequestState

bool ResetFileRequestState();

Deprecated - PS3 Only.

Возвращает: bool

SetCloudEnabledForApp

void SetCloudEnabledForApp( bool bEnabled );

Название	Тип	Описание
bEnabled	bool	Enable (true) or disable (false) the Steam Cloud for this application?

Toggles whether the Steam Cloud is enabled for your application.

This setting can be queried with IsCloudEnabledForApp.

ВНИМАНИЕ: This must only ever be called as the direct result of the user explicitly requesting that it's enabled or not. This is typically accomplished with a checkbox within your in-game options.

SetSyncPlatforms

bool SetSyncPlatforms( const char *pchFile, ERemoteStoragePlatform eRemoteStoragePlatform );

Название	Тип	Описание
pchFile	const char *	The name of the file.
eRemoteStoragePlatform	ERemoteStoragePlatform	The platforms that the file will be syncronized to.

Allows you to specify which operating systems a file will be synchronized to.

Use this if you have a multiplatform game but have data which is incompatible between platforms.

Files default to k_ERemoteStoragePlatformAll when they are first created. You can use the bitwise OR operator, "|" to specify multiple platforms.

Возвращает: bool
true if the file exists, otherwise false.

SetUserPublishedFileAction

SteamAPICall_t SetUserPublishedFileAction( PublishedFileId_t unPublishedFileId, EWorkshopFileAction eAction );

Название	Тип	Описание
unPublishedFileId	PublishedFileId_t
eAction	EWorkshopFileAction

Deprecated - Only used with the deprecated RemoteStorage based Workshop API.

Возвращает: SteamAPICall_t to be used with a RemoteStorageSetUserPublishedFileActionResult_t call result.

SubscribePublishedFile

SteamAPICall_t SubscribePublishedFile( PublishedFileId_t unPublishedFileId );

Название	Тип	Описание
unPublishedFileId	PublishedFileId_t

Устарело. Используется только с устаревшим API Мастерской, основанном на RemoteStorage.

Возвращает: SteamAPICall_t to be used with a RemoteStorageSubscribePublishedFileResult_t call result.

UGCDownload

SteamAPICall_t UGCDownload( UGCHandle_t hContent, uint32 unPriority );

Название	Тип	Описание
hContent	UGCHandle_t
unPriority	uint32

Возвращаемые значения: SteamAPICall_t to be used with a RemoteStorageDownloadUGCResult_t call result.

UGCDownloadToLocation

SteamAPICall_t UGCDownloadToLocation( UGCHandle_t hContent, const char *pchLocation, uint32 unPriority );

Название	Тип	Описание
hContent	UGCHandle_t
pchLocation	const char *
unPriority	uint32

Возвращает: SteamAPICall_t to be used with a RemoteStorageDownloadUGCResult_t call result.

UGCRead

int32 UGCRead( UGCHandle_t hContent, void *pvData, int32 cubDataToRead, uint32 cOffset, EUGCReadAction eAction );

Название	Тип	Описание
hContent	UGCHandle_t
pvData	void *
cubDataToRead	int32
cOffset	uint32
eAction	EUGCReadAction

Возвращает: int32

UnsubscribePublishedFile

SteamAPICall_t UnsubscribePublishedFile( PublishedFileId_t unPublishedFileId );

Название	Тип	Описание
unPublishedFileId	PublishedFileId_t

Deprecated - Only used with the deprecated RemoteStorage based Workshop API.

Возвращает: SteamAPICall_t to be used with a RemoteStorageUnsubscribePublishedFileResult_t call result.

UpdatePublishedFileDescription

bool UpdatePublishedFileDescription( PublishedFileUpdateHandle_t updateHandle, const char *pchDescription );

Название	Тип	Описание
updateHandle	PublishedFileUpdateHandle_t
pchDescription	const char *

Deprecated - Only used with the deprecated RemoteStorage based Workshop API.

Возвращаемые значения: bool

UpdatePublishedFileFile

bool UpdatePublishedFileFile( PublishedFileUpdateHandle_t updateHandle, const char *pchFile );

Название	Тип	Описание
updateHandle	PublishedFileUpdateHandle_t
pchFile	const char *

Deprecated - Only used with the deprecated RemoteStorage based Workshop API.

Возвращает: bool

UpdatePublishedFilePreviewFile

bool UpdatePublishedFilePreviewFile( PublishedFileUpdateHandle_t updateHandle, const char *pchPreviewFile );

Название	Тип	Описание
updateHandle	PublishedFileUpdateHandle_t
pchPreviewFile	const char *

Deprecated - Only used with the deprecated RemoteStorage based Workshop API.

Возвращаемые значения: bool

UpdatePublishedFileSetChangeDescription

bool UpdatePublishedFileSetChangeDescription( PublishedFileUpdateHandle_t updateHandle, const char *pchChangeDescription );

Название	Тип	Описание
updateHandle	PublishedFileUpdateHandle_t
pchChangeDescription	const char *

Deprecated - Only used with the deprecated RemoteStorage based Workshop API.

Returns: bool

UpdatePublishedFileTags

bool UpdatePublishedFileTags( PublishedFileUpdateHandle_t updateHandle, SteamParamStringArray_t *pTags );

Название	Тип	Описание
updateHandle	PublishedFileUpdateHandle_t
pTags	SteamParamStringArray_t *

Deprecated - Only used with the deprecated RemoteStorage based Workshop API.

Возвращает: bool

UpdatePublishedFileTitle

bool UpdatePublishedFileTitle( PublishedFileUpdateHandle_t updateHandle, const char *pchTitle );

Название	Тип	Описание
updateHandle	PublishedFileUpdateHandle_t
pchTitle	const char *

Deprecated - Only used with the deprecated RemoteStorage based Workshop API.

Returns: bool

UpdatePublishedFileVisibility

bool UpdatePublishedFileVisibility( PublishedFileUpdateHandle_t updateHandle, ERemoteStoragePublishedFileVisibility eVisibility );

Название	Тип	Описание
updateHandle	PublishedFileUpdateHandle_t
eVisibility	ERemoteStoragePublishedFileVisibility

Deprecated - Only used with the deprecated RemoteStorage based Workshop API.

Возвращает: bool

UpdateUserPublishedItemVote

SteamAPICall_t UpdateUserPublishedItemVote( PublishedFileId_t unPublishedFileId, bool bVoteUp );

Название	Тип	Описание
unPublishedFileId	PublishedFileId_t
bVoteUp	bool

Deprecated - Only used with the deprecated RemoteStorage based Workshop API.

Возвращаемые значения: SteamAPICall_t to be used with a RemoteStorageUpdateUserPublishedItemVoteResult_t call result.

Обратные вызовы

These are callbacks which can be fired by calling SteamAPI_RunCallbacks. Many of these will be fired directly in response to the member functions of ISteamRemoteStorage.

RemoteStorageAppSyncedClient_t

Deprecated - PS3 only.

Название	Тип	Описание
m_nAppID	AppId_t
m_eResult	EResult
m_unNumDownloads	int

RemoteStorageAppSyncedServer_t

Deprecated - PS3 only.

Название	Тип	Описание
m_nAppID	AppId_t
m_eResult	EResult
m_unNumUploads	int

RemoteStorageAppSyncProgress_t

Deprecated - PS3 only.

Название	Тип	Описание
m_rgchCurrentFile	char［k_cchFilenameMax］	Current file being transferred
m_nAppID	AppId_t	App this info relates to
m_uBytesTransferredThisChunk	uint32	Bytes transferred this chunk
m_dAppPercentComplete	double	Percent complete that this app's transfers are
m_bUploading	bool	if false, downloading

RemoteStorageAppSyncStatusCheck_t

Deprecated - PS3 only.

Название	Тип	Описание
m_nAppID	AppId_t
m_eResult	EResult

RemoteStorageDeletePublishedFileResult_t

Deprecated - Only used with the deprecated RemoteStorage based Workshop API.

Название	Тип	Описание
m_eResult	EResult	Результат операции.
m_nPublishedFileId	PublishedFileId_t

Связанные функции: DeletePublishedFile

RemoteStorageDownloadUGCResult_t

Название	Тип	Описание
m_eResult	EResult	Результат операции.
m_hFile	UGCHandle_t	The handle to the file that was attempted to be downloaded.
m_nAppID	AppId_t	ID of the app that created this file.
m_nSizeInBytes	int32	The size of the file that was downloaded, in bytes.
m_pchFileName	char［k_cchFilenameMax］	The name of the file that was downloaded.
m_ulSteamIDOwner	uint64	Steam ID of the user who created this content.

Связанные функции: UGCDownload, UGCDownloadToLocation

RemoteStorageEnumeratePublishedFilesByUserActionResult_t

Deprecated - Only used with the deprecated RemoteStorage based Workshop API.

Название	Тип	Описание
m_eResult	EResult	Результат операции.
m_eAction	EWorkshopFileAction	the action that was filtered on
m_nResultsReturned	int32
m_nTotalResultCount	int32
m_rgPublishedFileId	PublishedFileId_t［k_unEnumeratePublishedFilesMaxResults］
m_rgRTimeUpdated	uint32［k_unEnumeratePublishedFilesMaxResults］

Связанные функции: EnumeratePublishedFilesByUserAction

RemoteStorageEnumerateUserPublishedFilesResult_t

Deprecated - Only used with the deprecated RemoteStorage based Workshop API.

Название	Тип	Описание
m_eResult	EResult	Результат операции.
m_nResultsReturned	int32
m_nTotalResultCount	int32
m_rgPublishedFileId	PublishedFileId_t［k_unEnumeratePublishedFilesMaxResults］

Связанные функции: EnumerateUserPublishedFiles, EnumerateUserSharedWorkshopFiles

RemoteStorageEnumerateUserSharedWorkshopFilesResult_t

Deprecated - Only used with the deprecated RemoteStorage based Workshop API.

Название	Тип	Описание
m_eResult	EResult	Результат операции.
m_nResultsReturned	int32
m_nTotalResultCount	int32
m_rgPublishedFileId	PublishedFileId_t［k_unEnumeratePublishedFilesMaxResults］

RemoteStorageEnumerateUserSubscribedFilesResult_t

Deprecated - Only used with the deprecated RemoteStorage based Workshop API.

Название	Тип	Описание
m_eResult	EResult	The result of the operation.
m_nResultsReturned	int32
m_nTotalResultCount	int32
m_rgPublishedFileId	PublishedFileId_t［k_unEnumeratePublishedFilesMaxResults］
m_rgRTimeSubscribed	uint32［k_unEnumeratePublishedFilesMaxResults］

Связанные функции: EnumerateUserSubscribedFiles

RemoteStorageEnumerateWorkshopFilesResult_t

Deprecated - Only used with the deprecated RemoteStorage based Workshop API.

Название	Тип	Описание
m_eResult	EResult
m_nResultsReturned	int32
m_nTotalResultCount	int32
m_rgPublishedFileId	PublishedFileId_t［k_unEnumeratePublishedFilesMaxResults］
m_rgScore	float［k_unEnumeratePublishedFilesMaxResults］
m_nAppId	AppId_t
m_unStartIndex	uint32

Связанные функции: EnumeratePublishedWorkshopFiles

RemoteStorageFileReadAsyncComplete_t

Response when reading a file asyncrounously with FileReadAsync.

Название	Тип	Описание
m_hFileReadAsync	SteamAPICall_t	Call handle of the async read which was made, must be passed to FileReadAsyncComplete to get the data.
m_eResult	EResult	The result of the operation. If the local read was successful this will be k_EResultOK, you can then call FileReadAsyncComplete to get the data.
m_nOffset	uint32	Offset into the file this read was at.
m_cubRead	uint32	Amount of bytes read - will be the <= the amount requested.

Связанные функции: FileReadAsync

RemoteStorageFileShareResult_t

Название	Тип	Описание
m_eResult	EResult	The result of the operation
m_hFile	UGCHandle_t	The handle that can be shared with users and features
m_rgchFilename	char［k_cchFilenameMax］	The name of the file that was shared

Связанные функции: FileShare

RemoteStorageFileWriteAsyncComplete_t

Response when writing a file asyncrounously with FileWriteAsync.

Название	Тип	Описание
m_eResult	EResult	The result of the operation. If the local write was successful then this will be k_EResultOK - any other value likely indicates that the filename is invalid or the available quota would have been exceeded by the requested write. Any attempt to write files that exceed this size will return an EResult of k_EResultInvalidParam. Writing files to the cloud is limited to 100MiB.

Связанные функции: FileWriteAsync

RemoteStorageGetPublishedFileDetailsResult_t

Устарело. Используется только с устаревшим API мастерской, основанном на RemoteStorage.

Название	Тип	Описание
m_eResult	EResult	The result of the operation.
m_nPublishedFileId	PublishedFileId_t
m_nCreatorAppID	AppId_t	ID of the app that created this file.
m_nConsumerAppID	AppId_t	ID of the app that will consume this file.
m_rgchTitle	char［k_cchPublishedDocumentTitleMax］	title of document
m_rgchDescription	char［k_cchPublishedDocumentDescriptionMax］	description of document
m_hFile	UGCHandle_t	The handle of the primary file
m_hPreviewFile	UGCHandle_t	The handle of the preview file
m_ulSteamIDOwner	uint64	Steam ID of the user who created this content.
m_rtimeCreated	uint32	time when the published file was created
m_rtimeUpdated	uint32	time when the published file was last updated
m_eVisibility	ERemoteStoragePublishedFileVisibility
m_bBanned	bool
m_rgchTags	char［k_cchTagListMax］	comma separated list of all tags associated with this file
m_bTagsTruncated	bool	whether the list of tags was too long to be returned in the provided buffer
m_pchFileName	char［k_cchFilenameMax］	The name of the primary file
m_nFileSize	int32	Size of the primary file
m_nPreviewFileSize	int32	Size of the preview file
m_rgchURL	char［k_cchPublishedFileURLMax］	URL (for a video or a website)
m_eFileType	EWorkshopFileType	Type of the file
m_bAcceptedForUse	bool	developer has specifically flagged this item as accepted in the Workshop

Связанные функции: GetPublishedFileDetails

RemoteStorageGetPublishedItemVoteDetailsResult_t

Устарело. Используется только с устаревшим API мастерской, основанном на RemoteStorage.

Название	Тип	Описание
m_eResult	EResult
m_unPublishedFileId	PublishedFileId_t
m_nVotesFor	int32
m_nVotesAgainst	int32
m_nReports	int32
m_fScore	float

Связанные функции: GetPublishedItemVoteDetails, GetUserPublishedItemVoteDetails

RemoteStorageLocalFileChange_t

If a Steam app is flagged for supporting dynamic Steam Cloud sync, and a sync occurs, this callback will be posted to the app if any local files changed.

Связанные функции: GetLocalFileChangeCount, GetLocalFileChange

RemoteStoragePublishedFileDeleted_t

Deprecated - Only used with the deprecated RemoteStorage based Workshop API.

Название	Тип	Описание
m_nPublishedFileId	PublishedFileId_t	ID опубликованного файла
m_nAppID	AppId_t	ID приложения, использующего этот файл.

RemoteStoragePublishedFileSubscribed_t

Название	Тип	Описание
m_nPublishedFileId	PublishedFileId_t	ID опубликованного файла
m_nAppID	AppId_t	ID приложения, использующего этот файл.

RemoteStoragePublishedFileUnsubscribed_t

Название	Тип	Описание
m_nPublishedFileId	PublishedFileId_t	ID опубликованного файла
m_nAppID	AppId_t	ID приложения, использующего этот файл.

RemoteStoragePublishedFileUpdated_t

Deprecated - Only used with the deprecated RemoteStorage based Workshop API.

Название	Тип	Описание
m_nPublishedFileId	PublishedFileId_t	The published file id
m_nAppID	AppId_t	ID of the app that will consume this file.
m_ulUnused	uint64	not used anymore

RemoteStoragePublishFileProgress_t

Deprecated - Only used with the deprecated RemoteStorage based Workshop API.

Название	Тип	Описание
m_dPercentFile	double
m_bPreview	bool

Связанные функции: PublishWorkshopFile, PublishVideo

RemoteStoragePublishFileResult_t

Deprecated - Only used with the deprecated RemoteStorage based Workshop API.

Название	Тип	Описание
m_eResult	EResult	Результат операции.
m_nPublishedFileId	PublishedFileId_t
m_bUserNeedsToAcceptWorkshopLegalAgreement	bool

RemoteStorageSetUserPublishedFileActionResult_t

Устарело. Используется только с устаревшим API мастерской, основанном на RemoteStorage.

Название	Тип	Описание
m_eResult	EResult	Результат операции.
m_nPublishedFileId	PublishedFileId_t	The published file id
m_eAction	EWorkshopFileAction	the action that was attempted

Associated Functions: SetUserPublishedFileAction

RemoteStorageSubscribePublishedFileResult_t

Called when the user has subscribed to a piece of UGC. Result from ISteamUGC::SubscribeItem.

Название	Тип	Описание
m_eResult	EResult	Результат операции.
m_nPublishedFileId	PublishedFileId_t	The workshop item that the user subscribed to.

Associated Functions: SubscribePublishedFile

RemoteStorageUnsubscribePublishedFileResult_t

Called when the user has unsubscribed from a piece of UGC. Result from ISteamUGC::UnsubscribeItem.

Название	Тип	Описание
m_eResult	EResult	Результат операции.
m_nPublishedFileId	PublishedFileId_t	The workshop item that the user unsubscribed from.

Associated Functions: UnsubscribePublishedFile

RemoteStorageUpdatePublishedFileResult_t

Deprecated - Only used with the deprecated RemoteStorage based Workshop API.

Название	Тип	Описание
m_eResult	EResult	Результат операции.
m_nPublishedFileId	PublishedFileId_t
m_bUserNeedsToAcceptWorkshopLegalAgreement	bool

Associated Functions: CommitPublishedFileUpdate

RemoteStorageUpdateUserPublishedItemVoteResult_t

Deprecated - Only used with the deprecated RemoteStorage based Workshop API.

Название	Тип	Описание
m_eResult	EResult	Результат операции.
m_nPublishedFileId	PublishedFileId_t	ID опубликованного файла

Associated Functions: UpdateUserPublishedItemVote

RemoteStorageUserVoteDetails_t

Deprecated - Only used with the deprecated RemoteStorage based Workshop API.

Название	Тип	Описание
m_eResult	EResult	Результат операции.
m_nPublishedFileId	PublishedFileId_t	The published file id
m_eVote	EWorkshopVote	what the user voted

Структуры

These are structs which functions in ISteamRemoteStorage may return and/or interact with.

SteamParamStringArray_t

Название	Type	Описание
m_ppStrings	const char **	Array of strings.
m_nNumStrings	int32	The number of strings that are in [param]m_ppStrings[/param].

Перечисления

These are enums which are defined for use with ISteamRemoteStorage.

ERemoteStorageLocalFileChange

Ways in which a local file may be changed by Steam during the application session. See GetLocalFileChange.

Название	Значение	Описание
k_ERemoteStorageLocalFileChange_Invalid	0	Unused.
k_ERemoteStorageLocalFileChange_FileUpdated	1	The file contents changed.
k_ERemoteStorageLocalFileChange_FileDeleted	2	The file was deleted.

ERemoteStorageFilePathType

For APIs that may return file paths in different forms. See GetLocalFileChange.

Название	Значение	Описание
k_ERemoteStorageFilePathType_Invalid	0	Unused.
k_ERemoteStorageFilePathType_Absolute	1	An absolute disk path is provided. This type of path is used for files managed via AutoCloud.
k_ERemoteStorageFilePathType_APIFilename	2	An ISteamRemoteStorage API relative path is provided. This type of path is used for files managed via the ISteamRemoteStorage API methods (FileWrite, FileRead, etc).

ERemoteStoragePlatform

Sync Platforms flags. These can be used with SetSyncPlatforms to restrict a file to a specific OS.

Название	Значение	Описание
k_ERemoteStoragePlatformNone	0	This file will not be downloaded on any platform.
k_ERemoteStoragePlatformWindows	(1 << 0)	This file will download on Windows.
k_ERemoteStoragePlatformOSX	(1 << 1)	This file will download on macOS.
k_ERemoteStoragePlatformPS3	(1 << 2)	This file will download on the Playstation 3.
k_ERemoteStoragePlatformLinux	(1 << 3)	This file will download on SteamOS/Linux.
k_ERemoteStoragePlatformReserved2	(1 << 4)	Reserved.
k_ERemoteStoragePlatformAll	0xffffffff	This file will download on every platform. This is the default.

ERemoteStoragePublishedFileVisibility

Possible visibility states that a Workshop item can be in.

Название	Значение	Описание
k_ERemoteStoragePublishedFileVisibilityPublic	0	Visible to everyone.
k_ERemoteStoragePublishedFileVisibilityFriendsOnly	1	Visible to friends only.
k_ERemoteStoragePublishedFileVisibilityPrivate	2	Only visible to the creator. Setting an item to private is the closest that you can get to deleting a workshop item from the API.
k_ERemoteStoragePublishedFileVisibilityUnlisted	3	Visible to everyone, but will not be returned in any global queries. Will also not be returned in any user lists unless the caller is the creator or a subscriber.

EUGCReadAction

Possible UGC Read Actions used with UGCRead.

Название	Значение	Описание
k_EUGCRead_ContinueReadingUntilFinished	0	Keeps the file handle open unless the last byte is read. You can use this when reading large files (over 100MB) in sequential chunks. If the last byte is read, this will behave the same as k_EUGCRead_Close. Otherwise, it behaves the same as k_EUGCRead_ContinueReading. This value maintains the same behavior as before the EUGCReadAction parameter was introduced.
k_EUGCRead_ContinueReading	1	Keeps the file handle open. Use this when using UGCRead to seek to different parts of the file. When you are done seeking around the file, make a final call with k_EUGCRead_Close to close it.
k_EUGCRead_Close	2	Frees the file handle. Use this when you're done reading the content. To read the file from Steam again you will need to call UGCDownload again.

EWorkshopEnumerationType

Deprecated - Only used with the deprecated RemoteStorage based Workshop API.

Название	Значение	Описание
k_EWorkshopEnumerationTypeRankedByVote	0
k_EWorkshopEnumerationTypeRecent	1
k_EWorkshopEnumerationTypeTrending	2
k_EWorkshopEnumerationTypeFavoritesOfFriends	3
k_EWorkshopEnumerationTypeVotedByFriends	4
k_EWorkshopEnumerationTypeContentByFriends	5
k_EWorkshopEnumerationTypeRecentFromFollowedUsers	6

EWorkshopFileAction

Deprecated - Only used with the deprecated RemoteStorage based Workshop API.

Название	Значение	Описание
k_EWorkshopFileActionPlayed	0	The user has played with or on this item. (e.g. Loaded a weapon or level.)
k_EWorkshopFileActionCompleted	1	The user has completed this item. (e.g. Got to the end of a linear map.)

EWorkshopFileType

The way that a shared file will be shared with the community.

Название	Value	Описание
k_EWorkshopFileTypeFirst	0	Only used for enumerating.
k_EWorkshopFileTypeCommunity	0	Normal Workshop item that can be subscribed to.
k_EWorkshopFileTypeMicrotransaction	1	Workshop item that is meant to be voted on for the purpose of selling in-game. (See: Curated Workshop)
k_EWorkshopFileTypeCollection	2	A collection of Workshop items.
k_EWorkshopFileTypeArt	3	Artwork.
k_EWorkshopFileTypeVideo	4	External video.
k_EWorkshopFileTypeScreenshot	5	Screenshot.
k_EWorkshopFileTypeGame	6	Unused, used to be for Greenlight game entries
k_EWorkshopFileTypeSoftware	7	Unused, used to be for Greenlight software entries.
k_EWorkshopFileTypeConcept	8	Unused, used to be for Greenlight concepts.
k_EWorkshopFileTypeWebGuide	9	Steam web guide.
k_EWorkshopFileTypeIntegratedGuide	10	Application integrated guide.
k_EWorkshopFileTypeMerch	11	Workshop merchandise meant to be voted on for the purpose of being sold.
k_EWorkshopFileTypeControllerBinding	12	Steam Controller bindings.
k_EWorkshopFileTypeSteamworksAccessInvite	13	Only used internally in Steam.
k_EWorkshopFileTypeSteamVideo	14	Steam video.
k_EWorkshopFileTypeGameManagedItem	15	Managed completely by the game, not the user, and not shown on the web.
k_EWorkshopFileTypeMax	16	Only used for enumerating.

EWorkshopVideoProvider

Deprecated - Only used with the deprecated RemoteStorage based Workshop API.

Название	Value	Description
k_EWorkshopVideoProviderNone	0	The item has no video.
k_EWorkshopVideoProviderYoutube	1	The item has a Youtube video.

EWorkshopVote

Deprecated - Only used with the deprecated RemoteStorage based Workshop API.

Name	Value	Description
k_EWorkshopVoteUnvoted	0	The user has not voted.
k_EWorkshopVoteFor	1	The user has voted this item up.
k_EWorkshopVoteAgainst	2	The user has voted this item down.
k_EWorkshopVoteLater	3	The user has chosen to vote later.

Typedefs

These are typedefs which are defined for use with ISteamRemoteStorage.

Name	Base type	Description
PublishedFileId_t	uint64	A unique handle to an individual workshop item.
PublishedFileUpdateHandle_t	uint64	Deprecated - Only used with the deprecated RemoteStorage based Workshop API.
UGCFileWriteStreamHandle_t	uint64	Handle used when asynchronously writing to Steam Cloud.
UGCHandle_t	uint64	A unique handle to a piece of user generated content.

Константы

These are constants which are defined for use with ISteamRemoteStorage.

Name	Type	Value	Description
k_cchFilenameMax	uint32	260	The maximum length that a Steam Cloud file path can be.
k_cchPublishedDocumentChangeDescriptionMax	uint32	8000	Unused.
k_cchPublishedDocumentDescriptionMax	uint32	8000	The maximum size in bytes that a Workshop item description can be.
k_cchPublishedDocumentTitleMax	uint32	128 + 1	The maximum size in bytes that a Workshop item title can be.
k_cchPublishedFileURLMax	uint32	256	The maximum size in bytes that a Workshop item URL can be.
k_cchTagListMax	uint32	1024 + 1	The maximum size in bytes that a Workshop item comma separated tag list can be.
k_PublishedFileIdInvalid	PublishedFileId_t	0	An invalid Workshop item handle.
k_PublishedFileUpdateHandleInvalid	PublishedFileUpdateHandle_t	0xffffffffffffffffull	Deprecated - Only used with the deprecated RemoteStorage based Workshop API.
k_UGCFileStreamHandleInvalid	UGCFileWriteStreamHandle_t	0xffffffffffffffffull	Returned when an error has occured when using FileWriteStreamOpen.
k_UGCHandleInvalid	UGCHandle_t	0xffffffffffffffffull	An invalid UGC Handle. This is often returned by functions signifying an error.
k_unEnumeratePublishedFilesMaxResults	uint32	50	Deprecated - Only used with the deprecated RemoteStorage based Workshop API.
k_unMaxCloudFileChunkSize	uint32	100 * 1024 * 1024	Defines the largest allowed file size for the Steam Cloud. Cloud files cannot be written in a single chunk over 100MiB and cannot be over 200MiB total.
STEAMREMOTESTORAGE_INTERFACE_VERSION	const char *	"STEAMREMOTESTORAGE_INTERFACE_VERSION014"