이전에 등록된 사용자 변경 콜백을 등록 해제합니다.
구문
bool XUserUnregisterForChangeEvent(
XTaskQueueRegistrationToken token,
bool wait
)
매개 변수
token _In_
형식: XTaskQueueRegistrationToken
등록 해제할 콜백을 식별하는 XUserRegisterForChangeEvent가 반환한 토큰입니다.
wait _In_
형식: bool
보류 중인 콜백이 완료될 때까지 차단할지 여부를 나타냅니다.
반환 값
형식: bool
대기가 false이고 등록 해제가 보류 중이면 false를 반환합니다. 그렇지 않으면 true를 반환합니다.
설명
참고 항목
이 함수는 시간에 민감한 스레드에서 호출하는 것이 안전하지 않습니다. 자세한 내용은 시간에 민감한 스레드를 참조하세요.
알림 등록 해제:
등록 해제하면 등록된 콜백 집합의 토큰에 대한 콜백이 제거됩니다.
- 콜백 토큰에 대해 콜백이 실행되고 있지 않으면, 호출 시 true를 반환합니다.
- 콜백이 있고 실행 중이고 대기가 true면, 실행 중인 콜백이 완료될 때까지 호출이 차단됩니다.
- 콜백이 실행 중이고 대기가 false면 호출이 차단되지는 않지만, false가 반환됩니다. 토큰에 대한 콜백이 완료되면 토큰이 자동으로 등록 해제됩니다.
이 메커니즘은 다음과 같은 코딩 패턴을 허용합니다.
- 등록 해제 호출 후 콜백이 절대로 호출되지 않도록 등록 해제를 차단할 수도 있습니다.
- 차단하지 않도록 선택할 수 있습니다. 데이터를 삭제하기 전 콜백이 완료되게 해야 한다면, 대기에 false를 사용하여 등록 해제를 주기적으로 호출할 수 있습니다. 최종적으로 true가 반환되면 모든 콜백이 완료되고, 상태를 삭제할 수 있습니다.
- 등록 해제 호출이 콜백을 호출하지 않는다면, 대기에 대해 false만 전달하고 반환 값을 무시할 수 있습니다.
사용자 변경 콜백을 등록하려면 XUserRegisterForChangeEvent를 호출합니다. XUserChangeEvent 열거형은 변경 이벤트 형식을 지정합니다. XUserChangeEventCallback은 사용자 변경 이벤트에 대 한 콜백입니다.
다음 예제에서는 사용자 변경 이벤트를 처리하는 방법을 보여줍니다.
HRESULT RegisterForChanges()
{
RETURN_HR_IF(E_UNEXPECTED, _token.token != 0);
RETURN_IF_FAILED(XUserRegisterForChangeEvent(
_queue,
this,
UserChangeEventHandler,
&_token));
return S_OK;
}
void UnregisterForChanges()
{
XUserUnregisterForChangeEvent(_token, false);
_token.token = 0;
}
void UserChangeEventHandler(
XUserLocalId userLocalId,
XUserChangeEvent event)
{
auto iter = std::find_if(
_users.begin(),
_users.end(),
[&userLocalId](const User& candidate)
{
XUserLocalId candidateUserLocalId;
XUserGetLocalId(candidate.Handle(), &candidateUserLocalId);
return candidateUserLocalId == userLocalId;
});
// User not known
if (iter == _users.end())
{
return;
}
auto handle = iter->Handle();
// If a guest gets signed out, immediately close the handle
bool isGuest;
if (SUCCEEDED_LOG(XUserGetIsGuest(handle, &isGuest)) &&
isGuest &&
event == XUserChangeEvent::SignedOut)
{
_users.erase(iter);
}
if (event == XUserChangeEvent::SigningOut)
{
// Delay the user signing out just for fun
XUserSignOutDeferralHandle deferral;
if (SUCCEEDED_LOG(XUserGetSignOutDeferral(&deferral)))
{
// Hold the deferral for 5 seconds then close it
std::thread completeDeferralThread(
[deferral]()
{
std::this_thread::sleep_for(std::chrono::milliseconds(5000));
XUserCloseSignOutDeferralHandle(deferral);
});
completeDeferralThread.detach();
}
}
if (event == XUserChangeEvent::GamerPicture)
{
iter->LoadGamerPicAsync(_queue);
}
}
요구 사항
헤더: XUser.h
라이브러리: xgameruntime.lib
지원되는 플랫폼: Windows, Steam Deck, Xbox One 제품군 콘솔 및 Xbox Series 콘솔