XGameStreamingGetSessionId
This API returns a null-terminated opaque string that uniquely identifies the streaming session of the specified client.Syntax
Parameters
client _In_Type: XGameStreamingClientId The streaming client that is being queried. sessionIdSize _In_
Type: size_t The size of the
sessionId buffer.
sessionId _Out_writes_bytes_to_(sessionIdSize, *sessionIdUsed)Type: char* The buffer that will populated with the session id of the specified client. sessionIdUsed _Out_opt_
Type: size_t* The size in bytes of the value returned in the
sessionId buffer (including null terminator).
Return value
Type: HRESULT Returns S_OK if successful; otherwise, returns an error code.Potential Errors
For a list of error codes, see Error Codes.
Remarks
The string written tosessionId will never be larger than SessionIdMaxBytes, thus it can be pre-allocated. The layout/contents of a sessionId may change at a later date, and thus should only be interpreted as an opaque string. As with other client property APIs, it’s recommended to use XGameStreamingRegisterClientPropertiesChanged to register a callback for changes to the sessionId.
Example
Requirements
Header: xgamestreaming.hLibrary: xgameruntime.lib
Supported platforms: Windows, XBOX One family consoles and XBOX Series consoles
