XSystemGetXboxLiveSandboxId
Retrieves the XBOX Live sandbox ID.Syntax
Parameters
sandboxIdSize _In_Type: size_t The size of the sandboxId, in bytes. This value must be equal to or greater than the XSystemXboxLiveSandboxIdMaxBytes constant defined in XSystem.h. sandboxId _Out_writes_bytes_to_(sandboxIdSize,*sandboxIdUsed)
Type: char* The character buffer that will receive the sandbox ID. sandboxIdUsed _Out_opt_
Type: size_t* The actual size, in bytes, of the sandboxId buffer returned.
Return value
Type: HRESULT Returns S_OK if successful; otherwise, returns an error code. For a list of error codes, see Error Codes. If the function fails because sandboxIdSize is set to a value less than XSystemXboxLiveSandboxIdMaxBytes, the return value is set to HRESULT_FROM_WIN32(ERROR_INSUFFICIENT_BUFFER).Remarks
Together with the TitleID and the Service Configuration ID (SCID), the sandbox ID is critical to the development of XBOX Live titles and applications. The sandbox ID identifies your sandbox, which provides content isolation for your development kit during development. Content isolation ensures that you have a clean environment for developing and testing your title.Sandbox IDs are case sensitive.
Requirements
Header: XSystem.h Library: xgameruntime.lib Supported platforms: Windows, XBOX One family consoles and XBOX Series consolesConceptual documentation
See also
Configuring dev kit settings (NDA topic)Setting up sandboxes for XBOX Live development
XSystemGetConsoleId
XSystem