XGameStreamingGetSessionId

아티클
05/10/2023

이 API는 지정된 클라이언트의 스트리밍 세션을 고유하게 식별하는 Null로 끝나는 불투명 문자열을 반환합니다.

구문

HRESULT XGameStreamingGetSessionId(
        XGameStreamingClientId client,
        size_t sessionIdSize,
        char* sessionId,
        size_t* sessionIdUsed
)

매개 변수

client _In_
형식: XGameStreamingClientId

쿼리 중인 스트리밍 클라이언트입니다.

sessionIdSize _In_
형식: size_t

sessionId 버퍼의 크기입니다.

sessionId _Out_writes_bytes_to_(sessionIdSize, *sessionIdUsed)
형식: char*

지정된 클라이언트의 세션 ID로 채워지는 버퍼입니다.

sessionIdUsed _Out_opt_
형식: size_t*

sessionId 버퍼에 반환된 값의 크기(바이트)입니다(null 종결자 포함).

반환 값

형식: HRESULT

성공한 경우 S_OK를 반환하고, 그렇지 않으면 오류 코드를 반환합니다.

잠재적인 오류

오류 코드	오류 값	오류 발생 원인
E_GAMESTREAMING_NOT_INITIALIZED	0x89245400	XGameStreaming 런타임이 아직 초기화되지 않았습니다. 다른 API를 호출하기 전에 XGameStreamingInitialize를 호출합니다.
E_GAMESTREAMING_CLIENT_NOT_CONNECTED	0x89245401	지정된 클라이언트가 연결되어 있지 않습니다.
E_GAMESTREAMING_NO_DATA	0x89245402	요청한 데이터를 사용할 수 없습니다. 나중에 데이터를 사용할 수 있습니다.
E_NOT_SUFFICIENT_BUFFER	0x7A	sessionId는 세션 ID 및 Null 종료 문자를 보유할 만큼 크지 않습니다.

오류 코드 목록은 오류 코드를 참조하세요.

비고

sessionId에 기록된 문자열은 SessionIdMaxBytes보다 크지 않으므로 미리 할당할 수 있습니다. sessionId의 레이아웃/콘텐츠는 나중에 변경될 수 있으므로 불투명 문자열로만 해석되어야 합니다. 다른 클라이언트 속성 API와 마찬가지로 XGameStreamingRegisterClientPropertiesChanged 을(를) 사용하여 sessionId 변경 내용에 대한 콜백을 등록하는 것이 좋습니다.

예제

// Register for client properties changed notifications 
void GameStreamingClientManager::OnClientConnected(XGameStreamingClientId client)
{
    XGameStreamingClientPropertiesChangedRegistrationToken token = {0};
    XGameStreamingRegisterClientPropertiesChanged(
            client, m_taskQueue, this, &OnClientPropertiesChanged, &token);
}

void GameStreamingClientManager::OnClientPropertiesChanged(
    void* context,
    XGameStreamingClientId client,
    uint32_t updatedPropertiesCount,
    XGameStreamingClientProperty* updatedProperties)
{
    for (uint32_t i = 0; i < updatedPropertiesCount; ++i)
    {
        switch (updatedProperties[i])
        {
        case XGameStreamingClientProperty::SessionId:
        {
            // allocate memory for sessionId
            char sessionId[SessionIdMaxBytes];

            // get session id of the client
            size_t bytesUsed = 0;
            HRESULT hr = XGameStreamingGetSessionId(client, _countof(sessionId), sessionId, &bytesUsed);

            if (SUCCEEDED(hr)) {
                // Game logic to use session id
            }
            else if (hr == E_GAMESTREAMING_NO_DATA) {
                // Game logic to handle no data for client
            }
            else
            {
                // Default error case
                LogFormat(L"XGameStreamingGetSessionId failed %x", hr);
            }

            break;
        }

        default:
            // A characteristic we are not tracking - do nothing
            break;
        }
    }
}

요구 사항

헤더: xgamestreaming.h
라이브러리: xgameruntime.lib
지원되는 플랫폼: Windows, Xbox One 패밀리 콘솔 및 Xbox Series 콘솔

참고 항목

XGameStreaming XGameStreamingRegisterClientPropertiesChanged