Nintendo Switch Brew

NS services: Difference between revisions

← Older edit
No edit summary
 
(32 intermediate revisions by 3 users not shown)
Line 45: Line 45:
|-
|-
| 200 || [13.1.0+] SetRequiredAddOnContentsOnContentsAvailabilityTransition
| 200 || [13.1.0+] SetRequiredAddOnContentsOnContentsAvailabilityTransition
|-
| 300 || [16.0.0+] SetupHostAddOnContent
|-
| 301 || [16.0.0+] GetRegisteredAddOnContentPath
|-
| 302 || [16.0.0+] UpdateCachedList
|}
|}


Line 74: Line 80:
! Cmd || Name
! Cmd || Name
|-
|-
| 0 || [[#RequestContentsAuthorizationToken]]
| 0 || [16.0.0+] RequestContentsAuthorizationTokenDeprecated ([12.0.0-15.0.1] [[#RequestContentsAuthorizationToken]])
|-
| 1 || [16.0.0+] RequestContentsAuthorizationToken
|}
|}


Line 99: Line 107:
This is "nn::ns::detail::IApplicationManagerInterface".
This is "nn::ns::detail::IApplicationManagerInterface".


[3.0.0+] This service was replaced by [[#ns:am2, ns:ec, ns:rid, ns:rt, ns:web|ns:am2]].
[3.0.0+] This service was replaced by [[#ns:am2, ns:ec, ns:rid, ns:rt, ns:web, ns:ro, ns:sweb|ns:am2]].


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 111: Line 119:
| 2 || GetApplicationRecordUpdateSystemEvent
| 2 || GetApplicationRecordUpdateSystemEvent
|-
|-
| 3 || GetApplicationViewDeprecated
| 3 || GetApplicationView
|-
|-
| 4 || DeleteApplicationEntity
| 4 || DeleteApplicationEntity
Line 265: Line 273:
| 601 || [2.0.0+] [[#ListApplicationContentMetaStatus]]
| 601 || [2.0.0+] [[#ListApplicationContentMetaStatus]]
|-
|-
| 602 || [2.0.0+] ListAvailableAddOnContent
| 602 || [2.0.0+] ListOwnedAndInstalledAddOnContent
|-
|-
| 603 || [2.0.0+] GetOwnedApplicationContentMetaStatus
| 603 || [2.0.0+] GetOwnedApplicationContentMetaStatus
Line 307: Line 315:
| 908 || [2.0.0+] ListApplicationRecordInstalledContentMeta
| 908 || [2.0.0+] ListApplicationRecordInstalledContentMeta
|-
|-
| 1000 || [2.0.0+] RequestVerifyApplicationDeprecated
| 1000 || [2.0.0+] RequestVerifyApplication
|-
|-
| 1001 || [2.0.0+] CorruptApplicationForDebug
| 1001 || [2.0.0+] CorruptApplicationForDebug
Line 327: Line 335:
| 1502 || [2.0.0+] GetLastSdCardFormatUnexpectedResult
| 1502 || [2.0.0+] GetLastSdCardFormatUnexpectedResult
|-
|-
| 1503 || [2.0.0+]
| 1503 || [2.0.0+] DetachSdCard
|-
|-
| 1600 || [2.0.0+] GetSystemSeedForPseudoDeviceId
| 1600 || [2.0.0+] GetSystemSeedForPseudoDeviceId
Line 341: Line 349:


== ListApplicationRecord ==
== ListApplicationRecord ==
Takes a type-0x6 output buffer containing an array of the below record and an s32 entry_offset, returns an output s32 out_entrycount.
Takes a type-0x6 output buffer containing an array of [[#ApplicationRecord]] and an s32 entry_offset, returns an output s32 out_entrycount.


Returns an array of entries with the below format using the specified offset and count.
Returns an array of entries with the below format using the specified offset and count.
=== Application Record Format ===
{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x8
| [[NCM_services#ApplicationId|ApplicationId]]
|-
| 0x8
| 0x1
| Type? (Known values: 0x2=Installing?, 0x3=Installed / Gamecard inserted, 0x5=Gamecard not inserted, 0xB=Archived)
|-
| 0x9
| 0x1
| Unknown, usually 0x02
|-
| 0xA
| 0x6
| Unknown, usually zeros?
|-
| 0x10
| 0x1
| Unknown, seems to change between reboots and removing/reinserting gamecards
|-
| 0x11
| 0x7
| Unknown, usually zeros?
|}


== LaunchApplication ==
== LaunchApplication ==
Line 421: Line 397:


Loads cached [[control.nacp]] to buf+0 and the cached icon to buf+0x4000. Returns an error if the buffer is too small.
Loads cached [[control.nacp]] to buf+0 and the cached icon to buf+0x4000. Returns an error if the buffer is too small.
=== ApplicationControlSource ===
{| class="wikitable" border="1"
|-
! Value
! Description
|-
| 0x0
| CacheOnly (Returns data from cache)
|-
| 0x1
| Storage (Returns data from storage if not present in cache)
|-
| 0x2
| StorageOnly (Returns data from storage without using cache)
|}


== ListApplicationContentMetaStatus ==
== ListApplicationContentMetaStatus ==
Takes a type-0x6 output buffer containing an array of the below entries, an input s32 index and [[NCM_services#ApplicationId|ApplicationId]], returns an output s32 out_entrycount.
Takes a type-0x6 output buffer containing an array of [[#ApplicationContentMetaStatus]], an input s32 index and [[NCM_services#ApplicationId|ApplicationId]], returns an output s32 out_entrycount.


Returns 0x10-byte entries using the specified [[NCM_services#ApplicationId|ApplicationId]] starting at the specified index. Can only return game titles. The second entry if any is the update-title usually. When the input entryindex is >= totalentries, this will return 0 with out_entrycount=0.
Returns 0x10-byte entries using the specified [[NCM_services#ApplicationId|ApplicationId]] starting at the specified index. Can only return game titles. The second entry if any is the update-title usually. When the input entryindex is >= totalentries, this will return 0 with out_entrycount=0.


Entry structure:
= ns:am2, ns:ec, ns:rid, ns:rt, ns:web, ns:ro, ns:sweb =
{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x1
| [[NCM_services#ContentMetaType|ContentMetaType]] ("type")
|-
| 0x1
| 0x1
| [[NCM_services#StorageId|StorageId]] ("installedStorage")
|-
| 0x2
| 0x1
| Unknown. Non-zero with output from cmd 605, differs for app/update titles.
|-
| 0x3
| 0x1
| Padding
|-
| 0x4
| 0x4
| Version
|-
| 0x8
| 0x8
| [[NCM_services#ApplicationId|ApplicationId]]
|}
 
= ns:am2, ns:ec, ns:rid, ns:rt, ns:web, ns:ro, ns:sweb =
These are "nn::ns::detail::IServiceGetterInterface".
These are "nn::ns::detail::IServiceGetterInterface".


Line 652: Line 580:
| 83 || [4.0.0-6.2.0] CheckApplicationResumeRights
| 83 || [4.0.0-6.2.0] CheckApplicationResumeRights
|-
|-
| 84 || [4.0.0+] GetDynamicCommitEvent
| 84 || [4.0.0-16.1.0] GetDynamicCommitEvent
|-
|-
| 85 || [4.0.0+] [[#RequestUpdateApplication2]]
| 85 || [4.0.0+] [[#RequestUpdateApplication2]]
Line 674: Line 602:
| 96 || [6.0.0+] [[#AcquireApplicationLaunchInfo]]
| 96 || [6.0.0+] [[#AcquireApplicationLaunchInfo]]
|-
|-
| 97 || [6.0.0+] GetMainApplicationProgramIndexByApplicationLaunchInfo
| 97 || [6.0.0+] [[#GetMainApplicationProgramIndexByApplicationLaunchInfo]]
|-
|-
| 98 || [6.0.0+] EnableApplicationAllThreadDumpOnCrash
| 98 || [6.0.0+] EnableApplicationAllThreadDumpOnCrash
Line 734: Line 662:
| 405 || ListApplicationControlCacheEntryInfo
| 405 || ListApplicationControlCacheEntryInfo
|-
|-
| 406 || [6.0.0+] GetApplicationControlProperty
| 406 || [6.0.0-18.1.0] [[#GetApplicationControlProperty]]
|-
|-
| 407 || [8.0.0+] [[#ListApplicationTitle]]
| 407 || [8.0.0+] [[#ListApplicationTitle]]
Line 740: Line 668:
| 408 || [8.0.0+] [[#ListApplicationIcon]]
| 408 || [8.0.0+] [[#ListApplicationIcon]]
|-
|-
| 502 || [[#RequestCheckGameCardRegistration]]
| 411 || [19.0.0+]
|-
|-
| 503 || [[#RequestGameCardRegistrationGoldPoint]]
| 412 || [19.0.0+]
|-
|-
| 504 || [[#RequestRegisterGameCard]]
| 413 || [19.0.0+]
|-
|-
| 505 || [3.0.0+] [[#GetGameCardMountFailureEvent]]
| 414 || [19.0.0+]
|-
|-
| 506 || [3.0.0+] [[#IsGameCardInserted]]
| 415 || [19.0.0+]
|-
|-
| 507 || [3.0.0+] [[#EnsureGameCardAccess]]
| 416 || [19.0.0+]
|-
|-
| 508 || [3.0.0+] [[#GetLastGameCardMountFailureResult]]
| 417 || [19.0.0+] InvalidateAllApplicationControlCacheOfTheStage
|-
|-
| 509 || [5.0.0+] [[#ListApplicationIdOnGameCard]]
| 418 || [19.0.0+] InvalidateApplicationControlCacheOfTheStage
|-
|-
| 510 || [9.0.0+] [[#GetGameCardPlatformRegion]]
| 419 || [19.0.0+] RequestDownloadApplicationControlDataInBackground
|-
|-
| 600 || [[#CountApplicationContentMeta]]
| 420 || [19.0.0+] CloneApplicationControlDataCacheForDebug
|-
|-
| 601 || [[#ListApplicationContentMetaStatus]]
| 421 || [20.0.0+]
|-
|-
| 602 || [2.0.0-5.1.0] ListAvailableAddOnContent
| 422 || [20.0.0+]
|-
|-
| 603 || GetOwnedApplicationContentMetaStatus
| 423 || [20.0.0+]
|-
|-
| 604 || RegisterContentsExternalKey
| 424 || [20.0.0+]
|-
| 425 || [20.0.0+]
|-
| 426 || [20.0.0+]
|-
| 427 || [20.0.0+]
|-
| 502 || [[#RequestCheckGameCardRegistration]]
|-
| 503 || [[#RequestGameCardRegistrationGoldPoint]]
|-
| 504 || [[#RequestRegisterGameCard]]
|-
| 505 || [3.0.0+] [[#GetGameCardMountFailureEvent]]
|-
| 506 || [3.0.0+] [[#IsGameCardInserted]]
|-
| 507 || [3.0.0+] [[#EnsureGameCardAccess]]
|-
| 508 || [3.0.0+] [[#GetLastGameCardMountFailureResult]]
|-
| 509 || [5.0.0+] [[#ListApplicationIdOnGameCard]]
|-
| 510 || [9.0.0+] [[#GetGameCardPlatformRegion]]
|-
| 511 || [19.0.0+] GetGameCardWakenReadyEvent
|-
| 512 || [19.0.0+] IsGameCardApplicationRunning
|-
| 513 || [20.0.0+]
|-
| 514 || [20.0.0+]
|-
| 515 || [20.0.0+]
|-
| 600 || [[#CountApplicationContentMeta]]
|-
| 601 || [[#ListApplicationContentMetaStatus]]
|-
| 602 || [2.0.0-5.1.0] ListAvailableAddOnContent
|-
| 603 || GetOwnedApplicationContentMetaStatus
|-
| 604 || [1.0.0-15.0.1] RegisterContentsExternalKey
|-
|-
| 605 || ListApplicationContentMetaStatusWithRightsCheck
| 605 || ListApplicationContentMetaStatusWithRightsCheck
Line 777: Line 749:
|-
|-
| 610 || [14.0.0+] GetInstalledContentMetaStorage
| 610 || [14.0.0+] GetInstalledContentMetaStorage
|-
| 611 || [16.0.0+] PrepareAddOnContent
|-
|-
| 700 || PushDownloadTaskList
| 700 || PushDownloadTaskList
Line 830: Line 804:
| 916 || [11.0.0+] IsApplicationAutoDeleteDisabled
| 916 || [11.0.0+] IsApplicationAutoDeleteDisabled
|-
|-
| 1000 || [[#RequestVerifyApplicationDeprecated]]
| 917 || [20.0.0+]
|-
|-
| 1001 || CorruptApplicationForDebug
| 918 || [20.0.0+]
|-
|-
| 1002 || [3.0.0-9.2.0] [[#RequestVerifyAddOnContentsRights]]
| 919 || [20.0.0+]
|-
|-
| 1003 || [5.0.0+] [[#RequestVerifyApplication]]
| 920 || [20.0.0+]
|-
| 921 || [20.0.0+]
|-
| 922 || [20.0.0+]
|-
| 923 || [20.0.0+]
|-
| 928 || [20.0.0+]
|-
| 929 || [20.0.0+]
|-
| 930 || [20.0.0+]
|-
| 931 || [20.0.0+]
|-
| 933 || [20.1.0+]
|-
| 1000 || [[#RequestVerifyApplicationDeprecated]]
|-
| 1001 || CorruptApplicationForDebug
|-
| 1002 || [3.0.0-9.2.0] [[#RequestVerifyAddOnContentsRights]]
|-
| 1003 || [5.0.0+] [[#RequestVerifyApplication]]
|-
|-
| 1004 || [5.0.0+] CorruptContentForDebug
| 1004 || [5.0.0+] CorruptContentForDebug
Line 879: Line 877:
|-
|-
| 1506 || [9.0.0+] GetSdCardStartupStatus
| 1506 || [9.0.0+] GetSdCardStartupStatus
|-
| 1508 || [20.0.0+]
|-
| 1509 || [20.0.0+]
|-
| 1510 || [20.0.0+]
|-
| 1511 || [20.0.0+]
|-
| 1512 || [20.0.0+]
|-
|-
| 1600 || GetSystemSeedForPseudoDeviceId
| 1600 || GetSystemSeedForPseudoDeviceId
Line 895: Line 903:
|-
|-
| 1705 || [11.0.0+] [[#IsPatchAutoDeletableApplication]]
| 1705 || [11.0.0+] [[#IsPatchAutoDeletableApplication]]
|-
| 1706 || [20.0.0+]
|-
|-
| 1800 || IsNotificationSetupCompleted
| 1800 || IsNotificationSetupCompleted
Line 900: Line 910:
| 1801 || GetLastNotificationInfoCount
| 1801 || GetLastNotificationInfoCount
|-
|-
| 1802 || ListLastNotificationInfo
| 1802 || [[#ListLastNotificationInfo]]
|-
|-
| 1803 || [3.0.0+] ListNotificationTask
| 1803 || [3.0.0+] [[#ListNotificationTask]]
|-
|-
| 1900 || [3.0.0-12.1.0] IsActiveAccount
| 1900 || [3.0.0-12.1.0] IsActiveAccount
Line 949: Line 959:
|-
|-
| 2018 || [5.0.0+] [[#GetApplicationDeliveryInfoHash]]
| 2018 || [5.0.0+] [[#GetApplicationDeliveryInfoHash]]
|-
| 2019 || [20.0.0+]
|-
|-
| 2050 || [6.0.0+] [[#GetApplicationRightsOnClient]]
| 2050 || [6.0.0+] [[#GetApplicationRightsOnClient]]
|-
|-
| 2051 || [9.0.0+] InvalidateRightsIdCache
| 2051 || [9.0.0+] InvalidateRightsIdCache
|-
| 2052 || [20.0.0+]
|-
| 2053 || [20.0.0+]
|-
|-
| 2100 || [6.0.0+] [[#GetApplicationTerminateResult]]
| 2100 || [6.0.0+] [[#GetApplicationTerminateResult]]
Line 985: Line 1,001:
|-
|-
| 2182 || [6.0.0+] SetActiveRightsContextUsingStateToRightsEnvironment
| 2182 || [6.0.0+] SetActiveRightsContextUsingStateToRightsEnvironment
|-
| 2183 || [20.1.0+]
|-
|-
| 2190 || [6.0.0+] [[#GetRightsEnvironmentHandleForApplication]]
| 2190 || [6.0.0+] [[#GetRightsEnvironmentHandleForApplication]]
Line 1,017: Line 1,035:
|-
|-
| 2359 || [15.0.0+] IsMultiCoreDownloadEnabled
| 2359 || [15.0.0+] IsMultiCoreDownloadEnabled
|-
| 2360 || [19.0.0+] GetApplicationDownloadTaskCount
|-
| 2361 || [19.0.0+] GetMaxApplicationDownloadTaskCount
|-
| 2362 || [20.0.0+]
|-
| 2363 || [20.0.0+]
|-
| 2364 || [20.0.0+]
|-
| 2365 || [20.0.0+]
|-
| 2366 || [20.0.0+]
|-
| 2367 || [20.0.0+]
|-
| 2368 || [20.0.0+]
|-
|-
| 2400 || [8.0.0+] [[#GetPromotionInfo]]
| 2400 || [8.0.0+] [[#GetPromotionInfo]]
Line 1,022: Line 1,058:
| 2401 || [8.0.0+] CountPromotionInfo
| 2401 || [8.0.0+] CountPromotionInfo
|-
|-
| 2402 || [8.0.0+] ListPromotionInfo
| 2402 || [8.0.0+] [[#ListPromotionInfo|ListPromotionInfo]]
|-
|-
| 2403 || [8.0.0+] [[#ImportPromotionJsonForDebug]]
| 2403 || [8.0.0+] [[#ImportPromotionJsonForDebug]]
Line 1,034: Line 1,070:
| 2511 || [9.0.0+] [[#GetApplicationResource]]
| 2511 || [9.0.0+] [[#GetApplicationResource]]
|-
|-
| 2513 || [10.0.0+] LaunchMicroApplication ([9.0.0-9.2.0] LaunchPreomia)
| 2513 || [10.0.0+] [[#LaunchMicroApplication]] ([9.0.0-9.2.0] LaunchPreomia)
|-
|-
| 2514 || [9.0.0+] ClearTaskOfAsyncTaskManager
| 2514 || [9.0.0+] ClearTaskOfAsyncTaskManager
Line 1,042: Line 1,078:
| 2516 || [10.0.0-14.1.2] EnsureApplicationCertificate
| 2516 || [10.0.0-14.1.2] EnsureApplicationCertificate
|-
|-
| 2517 || [13.0.0+] CreateApplicationInstance
| 2517 || [13.0.0+] [[#CreateApplicationInstance]]
|-
|-
| 2518 || [13.0.0+] UpdateQualificationForDebug
| 2518 || [13.0.0+] UpdateQualificationForDebug
Line 1,050: Line 1,086:
| 2520 || [13.0.0+] IsQualificationTransitionSupportedByProcessId
| 2520 || [13.0.0+] IsQualificationTransitionSupportedByProcessId
|-
|-
| 2521 || [13.0.0+] GetRightsUserChangedEvent
| 2521 || [13.0.0-16.1.0] GetRightsUserChangedEvent
|-
|-
| 2522 || [14.0.0+] IsRomRedirectionAvailable
| 2522 || [14.0.0+] IsRomRedirectionAvailable
|-
| 2523 || [17.0.0+] GetProgramId
|-
| 2524 || [19.0.0+]
|-
| 2525 || [20.0.0+]
|-
|-
| 2800 || [9.0.0+] GetApplicationIdOfPreomia
| 2800 || [9.0.0+] GetApplicationIdOfPreomia
Line 1,085: Line 1,127:
|-
|-
| 3014 || [11.0.0+] [[#IsLocalContentShareEnabled]]
| 3014 || [11.0.0+] [[#IsLocalContentShareEnabled]]
|-
| 3015 || [18.0.0+] GetNetworkUpdateRequiredByGameCardDetectionEvent
|-
|-
| 3050 || [14.0.0+] ListAssignELicenseTaskResult
| 3050 || [14.0.0+] ListAssignELicenseTaskResult
|-
|-
| 9999 || [10.0.0-10.2.0] GetApplicationCertificate
| 3100 || [17.0.0+] GetSafeSystemVersionCheckInfo
|}
|-
 
| 3101 || [17.0.0+] RequestUpdateSafeSystemVersionCheckInfo
[4.0.0+] RequestDownloadAddOnContent now takes an additional 8-bytes of input.
|-
 
| 3102 || [17.0.0+] ResetSafeSystemVersionCheckInfo
==== GetApplicationRecordUpdateSystemEvent ====
|-
No input, returns an output Event handle with EventClearMode=1.
| 3104 || [18.0.0+] GetApplicationNintendoLogo
 
|-
==== GetApplicationViewDeprecated ====
| 3105 || [18.0.0+] GetApplicationStartupMovie
Takes a type-0x6 output buffer containing an array of [[#ApplicationViewDeprecated]], a type-0x5 input buffer containing an array of u64 [[NCM_services#ApplicationId|ApplicationIds]], no output.
|-
 
| 4000 || [20.0.0+]
On newer system-versions this is the same as [[#GetApplicationView]], except this converts the output from the func called in the loop from [[#ApplicationView]] to [[#ApplicationViewDeprecated]].
|-
 
| 4004 || [20.0.0+]
==== DeleteApplicationEntity ====
|-
Takes an input [[NCM_services#ApplicationId|ApplicationId]], no output.
| 4006 || [20.0.0+]
 
|-
==== DeleteApplicationCompletely ====
| 4007 || [20.0.0+]
Takes an input [[NCM_services#ApplicationId|ApplicationId]], no output.
|-
 
| 4008 || [20.0.0+]
==== DeleteRedundantApplicationEntity ====
|-
No input/output.
| 4009 || [20.0.0+]
 
|-
==== IsApplicationEntityMovable ====
| 4010 || [20.0.0+]
Takes an input u8 [[NCM_services#StorageId|StorageId]], an [[NCM_services#ApplicationId|ApplicationId]], returns an output u8 bool.
|-
 
| 4011 || [20.0.0+]
==== MoveApplicationEntity ====
|-
Takes an input u8 [[NCM_services#StorageId|StorageId]], an [[NCM_services#ApplicationId|ApplicationId]], no output.
| 4012 || [20.0.0+]
 
|-
==== RequestApplicationUpdateInfo ====
| 4013 || [20.0.0+]
Takes an input [[NCM_services#ApplicationId|ApplicationId]], returns an output Event handle and an [[#IAsyncValue]].
|-
 
| 4015 || [20.0.0+]
The data that can be read from the [[#IAsyncValue]] is [[#ApplicationUpdateInfo]].
|-
 
| 4017 || [20.0.0+]
Before using the cmd, official sw uses [[Network_Interface_services#IsAnyInternetRequestAccepted|IsAnyInternetRequestAccepted]] with the output from [[#Network_Interface_services#GetClientId|GetClientId]], throwing an error when the returned bool is false.
|-
 
| 4019 || [20.0.0+]
==== CancelApplicationDownload ====
|-
Takes an input [[NCM_services#ApplicationId|ApplicationId]], no output.
| 4020 || [20.0.0+]
 
|-
==== ResumeApplicationDownload ====
| 4021 || [20.0.0+]
Takes an input [[NCM_services#ApplicationId|ApplicationId]], no output.
|-
 
| 4022 || [20.0.0+]
==== CheckApplicationLaunchVersion ====
|-
Takes an input [[NCM_services#ApplicationId|ApplicationId]], no output.
| 4023 || [20.0.0+]
 
|-
==== CalculateApplicationDownloadRequiredSize ====
| 4024 || [20.0.0+]
Takes an input u8 [[NCM_services#StorageId|StorageId]], an [[NCM_services#ApplicationId|ApplicationId]], returns an output s64.
|-
 
| 4025 || [20.0.0+]
==== CleanupSdCard ====
|-
No input/output.
| 4026 || [20.0.0+]
 
|-
==== GetSdCardMountStatusChangedEvent ====
| 4027 || [20.0.0+]
No input, returns an output Event handle with EventClearMode=0.
|-
 
| 4028 || [20.0.0+]
==== GetGameCardUpdateDetectionEvent ====
|-
No input, returns an output Event handle with EventClearMode=0.
| 4029 || [20.0.0+]
 
|-
==== DisableApplicationAutoDelete ====
| 4030 || [20.0.0+]
Takes an input [[NCM_services#ApplicationId|ApplicationId]], no output.
|-
 
| 4031 || [20.0.0+]
==== EnableApplicationAutoDelete ====
|-
Takes an input [[NCM_services#ApplicationId|ApplicationId]], no output.
| 4032 || [20.0.0+]
|-
| 4033 || [20.0.0+]
|-
| 4034 || [20.0.0+]
|-
| 4035 || [20.0.0+]
|-
| 4037 || [20.0.0+]
|-
| 4038 || [20.0.0+]
|-
| 4039 || [20.0.0+]
|-
| 4040 || [20.0.0+]
|-
| 4041 || [20.0.0+]
|-
| 4042 || [20.0.0+]
|-
| 4043 || [20.0.0+]
|-
| 4044 || [20.0.0+]
|-
| 4045 || [20.0.0+]
|-
| 4046 || [20.0.0+]
|-
| 4049 || [20.0.0+]
|-
| 4050 || [20.0.0+]
|-
| 4051 || [20.0.0+]
|-
| 4052 || [20.0.0+]
|-
| 4053 || [20.0.0+]
|-
| 4054 || [20.0.0+]
|-
| 4055 || [20.0.0+]
|-
| 4056 || [20.0.0+]
|-
| 4057 || [20.0.0+]
|-
| 4058 || [20.0.0+]
|-
| 4059 || [20.0.0+]
|-
| 4060 || [20.0.0+]
|-
| 4061 || [20.0.0+]
|-
| 4062 || [20.0.0+]
|-
| 4063 || [20.0.0+]
|-
| 4064 || [20.0.0+]
|-
| 4065 || [20.0.0+]
|-
| 4066 || [20.0.0+]
|-
| 4067 || [20.0.0+]
|-
| 4068 || [20.0.0+]
|-
| 4069 || [20.0.0+]
|-
| 4070 || [20.0.0+]
|-
| 4071 || [20.0.0+]
|-
| 4072 || [20.0.0+]
|-
| 4073 || [20.0.0+]
|-
| 4074 || [20.0.0+]
|-
| 4075 || [20.0.0+]
|-
| 4076 || [20.0.0+]
|-
| 4077 || [20.0.0+]
|-
| 4078 || [20.0.0+]
|-
| 4079 || [20.0.0+]
|-
| 4080 || [20.0.0+]
|-
| 4081 || [20.0.0+]
|-
| 4083 || [20.0.0+]
|-
| 4084 || [20.0.0+]
|-
| 4085 || [20.0.0+]
|-
| 4086 || [20.0.0+]
|-
| 4087 || [20.0.0+]
|-
| 4088 || [20.0.0+]
|-
| 4089 || [20.0.0+]
|-
| 4090 || [20.0.0+]
|-
| 4091 || [20.0.0+]
|-
| 4092 || [20.0.0+]
|-
| 4093 || [20.0.0+]
|-
| 4094 || [20.0.0+]
|-
| 4095 || [20.0.0+]
|-
| 4096 || [20.0.0+]
|-
| 4097 || [20.0.0+]
|-
| 5000 || [18.0.0+]
|-
| 5001 || [18.0.0+]  
|-
| 9999 || [10.0.0-10.2.0] GetApplicationCertificate
|}


==== SetApplicationTerminateResult ====
[4.0.0+] RequestDownloadAddOnContent now takes an additional 8-bytes of input.
Takes an input u32 Result, an [[NCM_services#ApplicationId|ApplicationId]], no output.


==== ClearApplicationTerminateResult ====
==== GetApplicationRecordUpdateSystemEvent ====
Takes an input [[NCM_services#ApplicationId|ApplicationId]], no output.
No input, returns an output Event handle with EventClearMode=1.


==== GetLastSdCardMountUnexpectedResult ====
==== GetApplicationViewDeprecated ====
No input/output.
Takes a type-0x6 output buffer containing an array of [[#ApplicationViewDeprecated]], a type-0x5 input buffer containing an array of u64 [[NCM_services#ApplicationId|ApplicationIds]], no output.


==== GetRequestServerStopper ====
On newer system-versions this is the same as [[#GetApplicationView]], except this converts the output from the func called in the loop from [[#ApplicationView]] to [[#ApplicationViewDeprecated]].
No input, returns an output [[#IRequestServerStopper]].


==== CancelApplicationApplyDelta ====
==== DeleteApplicationEntity ====
Takes an input [[NCM_services#ApplicationId|ApplicationId]], no output.
Takes an input [[NCM_services#ApplicationId|ApplicationId]], no output.


==== ResumeApplicationApplyDelta ====
==== DeleteApplicationCompletely ====
Takes an input [[NCM_services#ApplicationId|ApplicationId]], no output.
Takes an input [[NCM_services#ApplicationId|ApplicationId]], no output.


==== CalculateApplicationApplyDeltaRequiredSize ====
==== DeleteRedundantApplicationEntity ====
Takes an input u8 [[NCM_services#StorageId|StorageId]], an [[NCM_services#ApplicationId|ApplicationId]], returns an output s64.
 
==== ResumeAll ====
No input/output.
No input/output.


==== GetStorageSize ====
==== IsApplicationEntityMovable ====
Takes an input u8 [[NCM_services#StorageId|StorageId]], returns two output s64s.
Takes an input u8 [[NCM_services#StorageId|StorageId]], an [[NCM_services#ApplicationId|ApplicationId]], returns an output u8 bool.


This temporarily mounts the [[Filesystem_services#OpenContentStorageFileSystem|ContentStorage]] specified by the StorageId (must be BuiltInUser or SdCard). The two output s64s are the output from [[Filesystem_services#GetTotalSpaceSize|GetTotalSpaceSize]] and [[Filesystem_services#GetFreeSpaceSize|GetFreeSpaceSize]] with this ContentStorage, with it this being unmounted afterwards.
==== MoveApplicationEntity ====
Takes an input u8 [[NCM_services#StorageId|StorageId]], an [[NCM_services#ApplicationId|ApplicationId]], no output.


==== RequestUpdateApplication2 ====
==== RequestApplicationUpdateInfo ====
Takes an input [[NCM_services#ApplicationId|ApplicationId]], returns an output Event handle and an [[#IAsyncResult]].
Takes an input [[NCM_services#ApplicationId|ApplicationId]], returns an output Event handle and an [[#IAsyncValue]].


See [[#RequestApplicationUpdateInfo]] regarding nifm.
The data that can be read from the [[#IAsyncValue]] is [[#ApplicationUpdateInfo]].


==== LaunchApplication ====
Before using the cmd, official sw uses [[Network_Interface_services#IsAnyInternetRequestAccepted|IsAnyInternetRequestAccepted]] with the output from [[Network_Interface_services#GetClientId|GetClientId]], throwing an error when the returned bool is false.
Takes an input u8 ProgramIndex, an input [[#ApplicationLaunchInfo]], returns an output u64.


==== GetApplicationLaunchInfo ====
==== CancelApplicationDownload ====
Takes an input [[NCM_services#ApplicationId|ApplicationId]], returns an output [[#ApplicationLaunchInfo]].
Takes an input [[NCM_services#ApplicationId|ApplicationId]], no output.


==== AcquireApplicationLaunchInfo ====
==== ResumeApplicationDownload ====
Takes an input [[NCM_services#ApplicationId|ApplicationId]], returns an output [[#ApplicationLaunchInfo]].
Takes an input [[NCM_services#ApplicationId|ApplicationId]], no output.
 
==== CheckApplicationLaunchVersion ====
Takes an input [[NCM_services#ApplicationId|ApplicationId]], no output.


This verifies that a state flag is set and that a state field matches the input ApplicationId, throwing an error otherwise. The [[#ApplicationLaunchInfo]] from state is copied to output, then the state flag is cleared.
==== CalculateApplicationDownloadRequiredSize ====
Takes an input u8 [[NCM_services#StorageId|StorageId]], an [[NCM_services#ApplicationId|ApplicationId]], returns an output s64.


==== LaunchDevMenu ====
==== CleanupSdCard ====
No input/output.
No input/output.


This is used by AM cmd [[Applet_Manager_services#LaunchDevMenu|LaunchDevMenu]].
==== GetSdCardMountStatusChangedEvent ====
No input, returns an output Event handle with EventClearMode=0.


This loads ProgramIds from [[System_Settings|system-settings]] <code>ns.applet!devmenu_id</code> and <code>ns.applet!devoverlaydisp_id</code>, which only exists on devunits. An error is thrown if loading these fail.
==== GetGameCardUpdateDetectionEvent ====
No input, returns an output Event handle with EventClearMode=0.


[[NCM_services#ncm|OpenContentMetaDatabase]] is used with StorageId = NandSystem, then IContentMetaDatabase GetLatestContentMetaKey is used with both of the above ProgramIds to verify that the cmd is successful.
==== DisableApplicationAutoDelete ====
Takes an input [[NCM_services#ApplicationId|ApplicationId]], no output.


Then if the above succeeds, the above titles are launched with the above StorageId via [[Process_Manager_services|pmshell]] LaunchProgram ([10.0.0+] [[PGL_services#LaunchProgram|pgl]] with pgl_launch_flags=0), with a 0.5s sleep-thread afterwards on success. [[Process_Manager_services#LaunchFlags|LaunchFlags]] value 0xB is used here.
==== EnableApplicationAutoDelete ====
Takes an input [[NCM_services#ApplicationId|ApplicationId]], no output.


==== DeleteUserSaveDataAll ====
==== SetApplicationTerminateResult ====
Takes an input [[Account_services#Uid|Uid]], returns an output [[#IProgressMonitorForDeleteUserSaveDataAll]].
Takes an input u32 Result, an [[NCM_services#ApplicationId|ApplicationId]], no output.


On success, [[#IProgressMonitorForDeleteUserSaveDataAll]] GetProgress is used with the output being copied into object state.
==== ClearApplicationTerminateResult ====
Takes an input [[NCM_services#ApplicationId|ApplicationId]], no output.


==== DeleteUserSystemSaveData ====
==== GetLastSdCardMountUnexpectedResult ====
Takes an input [[Account_services#Uid|Uid]], an u64 SystemSaveDataId, no output.
No input/output.


==== DeleteSaveData ====
==== GetRequestServerStopper ====
Takes an input u8 [[Filesystem_services#SaveDataSpaceId|SaveDataSpaceId]], an u64 SaveDataId, no output.
No input, returns an output [[#IRequestServerStopper]].


==== UnregisterNetworkServiceAccount ====
==== CancelApplicationApplyDelta ====
Takes an input [[Account_services#Uid|Uid]], no output.
Takes an input [[NCM_services#ApplicationId|ApplicationId]], no output.


==== UnregisterNetworkServiceAccountWithUserSaveDataDeletion ====
==== ResumeApplicationApplyDelta ====
Takes an input [[Account_services#Uid|Uid]], no output.
Takes an input [[NCM_services#ApplicationId|ApplicationId]], no output.


==== LaunchLibraryApplet ====
==== CalculateApplicationApplyDeltaRequiredSize ====
Takes an input u64 [[NCM_services#ProgramId|ProgramId]], returns an output u64.
Takes an input u8 [[NCM_services#StorageId|StorageId]], an [[NCM_services#ApplicationId|ApplicationId]], returns an output s64.


The specified program is launched with StorageId=BuiltInSystem via [[Process_Manager_services|pmshell]] LaunchProgram ([10.0.0+] [[PGL_services#LaunchProgram|pgl]] with pgl_launch_flags=0). [[Process_Manager_services#LaunchFlags|LaunchFlags]] value 0x9 is used here. The output u64 from here is written to the output for this cmd, on success.
==== ResumeAll ====
No input/output.


This is used by [[Applet_Manager_services|AM]].
==== GetStorageSize ====
Takes an input u8 [[NCM_services#StorageId|StorageId]], returns two output s64s.


==== LaunchSystemApplet ====
This temporarily mounts the [[Filesystem_services#OpenContentStorageFileSystem|ContentStorage]] specified by the StorageId (must be BuiltInUser or SdCard). The two output s64s are the output from [[Filesystem_services#GetTotalSpaceSize|GetTotalSpaceSize]] and [[Filesystem_services#GetFreeSpaceSize|GetFreeSpaceSize]] with this ContentStorage, with it this being unmounted afterwards.
No input, returns an output u64.


A state flag must be zero, otherwise an error is thrown. When a state field is value 1, a hard-coded ProgramId for MaintenanceMenu is used. Otherwise, the ProgramId is loaded from [[System_Settings|system-setting]] <code>ns.applet!system_applet_id</code>.
==== RequestUpdateApplication2 ====
Takes an input [[NCM_services#ApplicationId|ApplicationId]], returns an output Event handle and an [[#IAsyncResult]].


The SystemApplet is launched with StorageId=BuiltInSystem via [[Process_Manager_services|pmshell]] LaunchProgram ([10.0.0+] [[PGL_services#LaunchProgram|pgl]] with pgl_launch_flags=0). [[Process_Manager_services#LaunchFlags|LaunchFlags]] value 0x9 is used here. The output u64 from here is written to the output for this cmd, on success.
See [[#RequestApplicationUpdateInfo]] regarding nifm.


This is used by [[Applet_Manager_services|AM]].
==== LaunchApplication ====
Takes an input u8 ProgramIndex, an input [[#ApplicationLaunchInfo]], returns an output u64.


==== LaunchOverlayApplet ====
[18.0.0+] Now takes a total of 0x58 bytes of input.
No input, returns an output u64.


A state flag must be zero, otherwise an error is thrown. The ProgramId is loaded from [[System_Settings|system-setting]] <code>ns.applet!overlay_applet_id</code>.
[19.0.0+] Now takes a total of 0x88 bytes of input.


The OverlayApplet is launched with StorageId=BuiltInSystem via [[Process_Manager_services|pmshell]] LaunchProgram ([10.0.0+] [[PGL_services#LaunchProgram|pgl]] with pgl_launch_flags=0). [[Process_Manager_services#LaunchFlags|LaunchFlags]] value 0x9 is used here. The output u64 from here is written to the output for this cmd, on success.
==== GetApplicationLaunchInfo ====
Takes an input [[NCM_services#ApplicationId|ApplicationId]], returns an output [[#ApplicationLaunchInfo]].


This is used by [[Applet_Manager_services|AM]].
[18.0.0+] Now returns a total of 0x50 bytes of output.


==== RequestDownloadApplicationControlData ====
[19.0.0+] Now returns a total of 0x80 bytes of output.
Takes an input [[NCM_services#ApplicationId|ApplicationId]], returns an output Event handle and an [[#IAsyncResult]].


See [[#RequestApplicationUpdateInfo]] regarding nifm.
==== AcquireApplicationLaunchInfo ====
Takes an input [[NCM_services#ApplicationId|ApplicationId]], returns an output [[#ApplicationLaunchInfo]].


==== ListApplicationTitle ====
This verifies that a state flag is set and that a state field matches the input ApplicationId, throwing an error otherwise. The [[#ApplicationLaunchInfo]] from state is copied to output, then the state flag is cleared.
Takes an input TransferMemory handle, a type-0x5 input buffer containing an array of u64 [[NCM_services#ApplicationId|ApplicationIds]], an u8 [[#ApplicationControlSource]], an u64 size, returns an output Event handle and an [[#IAsyncValue]].


[[qlaunch]] uses value 0x1 for the u8.
[18.0.0+] Now returns a total of 0x50 bytes of output.


The user-process creates the TransferMemory with permissions=R--.
[19.0.0+] Now returns a total of 0x80 bytes of output.


The data available with [[#IAsyncValue]] Get is a s32 for the offset within the TransferMemory where the output data is located, GetSize returns the total byte-size of the data located here. The data located here is the [[NACP_Format|NACP]] title-entry for each specified ApplicationId.
==== GetMainApplicationProgramIndexByApplicationLaunchInfo ====
[18.0.0+] Now takes a total of 0x50 bytes of input.


The TransferMemory size must be at least: count*sizeof([[NACP_Format|title-entry]]) + count*sizeof(u64) + count*[[#GetApplicationControlData|0x24000]].
[19.0.0+] Now returns a total of 0x80 bytes of output.


This is essentially an async wrapper for [[#GetApplicationControlData]], with support for multiple ApplicationIds.
==== LaunchDevMenu ====
No input/output.


==== ListApplicationIcon ====
This is used by AM cmd [[Applet_Manager_services#LaunchDevMenu|LaunchDevMenu]].
Takes an input TransferMemory handle, a type-0x5 input buffer containing an array of u64 [[NCM_services#ApplicationId|ApplicationIds]], an u8 [[#ApplicationControlSource]], an u64 size, returns an output Event handle and an [[#IAsyncValue]].


The user-process creates the TransferMemory with permissions=R--.
This loads ProgramIds from [[System_Settings|system-settings]] <code>ns.applet!devmenu_id</code> and <code>ns.applet!devoverlaydisp_id</code>, which only exists on devunits. An error is thrown if loading these fail.


The data available with [[#IAsyncValue]] Get is a s32 for the offset within the TransferMemory where the output data is located, GetSize returns the total byte-size of the data located here. This data is: an u64 for total entries, an array of u64s for each icon size, then the icon JPEGs for the specified ApplicationIds.
[[NCM_services#ncm|OpenContentMetaDatabase]] is used with StorageId = NandSystem, then IContentMetaDatabase GetLatestContentMetaKey is used with both of the above ProgramIds to verify that the cmd is successful.


The TransferMemory size must be at least: 0x4 + count*sizeof(u64) + count*[[#GetApplicationControlData|0x20000]] + count*sizeof(u64) + [[#GetApplicationControlData|0x24000]].
Then if the above succeeds, the above titles are launched with the above StorageId via [[Process_Manager_services|pmshell]] LaunchProgram ([10.0.0+] [[PGL_services#LaunchProgram|pgl]] with pgl_launch_flags=0), with a 0.5s sleep-thread afterwards on success. [[Process_Manager_services#LaunchFlags|LaunchFlags]] value 0xB is used here.


This is essentially an async wrapper for [[#GetApplicationControlData]], with support for multiple ApplicationIds.
==== DeleteUserSaveDataAll ====
Takes an input [[Account_services#Uid|Uid]], returns an output [[#IProgressMonitorForDeleteUserSaveDataAll]].


==== RequestCheckGameCardRegistration ====
On success, [[#IProgressMonitorForDeleteUserSaveDataAll]] GetProgress is used with the output being copied into object state.
Takes an input [[NCM_services#ApplicationId|ApplicationId]], returns an output Event handle and an [[#IAsyncResult]].


See [[#RequestApplicationUpdateInfo]] regarding nifm.
==== DeleteUserSystemSaveData ====
Takes an input [[Account_services#Uid|Uid]], an u64 SystemSaveDataId, no output.


==== RequestGameCardRegistrationGoldPoint ====
==== DeleteSaveData ====
Takes an input [[Account_services#Uid|Uid]], an [[NCM_services#ApplicationId|ApplicationId]], returns an output Event handle and an [[#IAsyncValue]].
Takes an input u8 [[Filesystem_services#SaveDataSpaceId|SaveDataSpaceId]], an u64 SaveDataId, no output.


The data that can be read from the [[#IAsyncValue]] is 4-bytes.
==== UnregisterNetworkServiceAccount ====
Takes an input [[Account_services#Uid|Uid]], no output.


See [[#RequestApplicationUpdateInfo]] regarding nifm.
==== UnregisterNetworkServiceAccountWithUserSaveDataDeletion ====
Takes an input [[Account_services#Uid|Uid]], no output.


==== RequestRegisterGameCard ====
==== LaunchLibraryApplet ====
Takes an input s32, an [[Account_services#Uid|Uid]], an [[NCM_services#ApplicationId|ApplicationId]], returns an output Event handle and an [[#IAsyncResult]].
Takes an input u64 [[NCM_services#ProgramId|ProgramId]], returns an output u64.


See [[#RequestApplicationUpdateInfo]] regarding nifm.
The specified program is launched with StorageId=BuiltInSystem via [[Process_Manager_services|pmshell]] LaunchProgram ([10.0.0+] [[PGL_services#LaunchProgram|pgl]] with pgl_launch_flags=0). [[Process_Manager_services#LaunchFlags|LaunchFlags]] value 0x9 is used here. The output u64 from here is written to the output for this cmd, on success.


==== GetGameCardMountFailureEvent ====
This is used by [[Applet_Manager_services|AM]].
No input, returns an output Event handle with EventClearMode=0.


==== IsGameCardInserted ====
==== LaunchSystemApplet ====
No input, returns an output u8 bool.
No input, returns an output u64.


==== EnsureGameCardAccess ====
A state flag must be non-zero, otherwise an error is thrown. When a state field is value 1, a hard-coded ProgramId for MaintenanceMenu is used. Otherwise, the ProgramId is loaded from [[System_Settings|system-setting]] <code>ns.applet!system_applet_id</code> ([20.0.0+] <code>ns.applet!system_applet_id_gen2</code>).
No input/output.


==== GetLastGameCardMountFailureResult ====
The SystemApplet is launched with StorageId=BuiltInSystem via [[Process_Manager_services|pmshell]] LaunchProgram ([10.0.0+] [[PGL_services#LaunchProgram|pgl]] with pgl_launch_flags=0). [[Process_Manager_services#LaunchFlags|LaunchFlags]] value 0x9 is used here. The output u64 from here is written to the output for this cmd, on success.
No input/output.


==== ListApplicationIdOnGameCard ====
This is used by [[Applet_Manager_services|AM]].
Takes a type-0x6 output buffer containing an array of u64 [[NCM_services#ApplicationId|ApplicationIds]], returns an output s32 for total output entries.


==== GetGameCardPlatformRegion ====
==== LaunchOverlayApplet ====
No input, returns an u8 '''GameCardPlatformRegion''' (0x00 = Global, 0x01 = China).
No input, returns an output u64.


This calls [[Filesystem_services#IDeviceOperator|fsp-srv IDeviceOperator]] GetGameCardCompatibilityType and returns the result.
A state flag must be non-zero, otherwise an error is thrown. The ProgramId is loaded from [[System_Settings|system-setting]] <code>ns.applet!overlay_applet_id</code>.


==== ListAvailableAddOnContent ====
The OverlayApplet is launched with StorageId=BuiltInSystem via [[Process_Manager_services|pmshell]] LaunchProgram ([10.0.0+] [[PGL_services#LaunchProgram|pgl]] with pgl_launch_flags=0). [[Process_Manager_services#LaunchFlags|LaunchFlags]] value 0x9 is used here. The output u64 from here is written to the output for this cmd, on success.
[10.0.0+] This now takes a total of 0x10-bytes of input instead of a total of 0x18-bytes of input.


[15.0.0+] This now takes a total of 0x8-bytes of input instead of a total of 0x10-bytes of input.
This is used by [[Applet_Manager_services|AM]].


==== RequestDownloadTaskListData ====
==== RequestDownloadApplicationControlData ====
No input, returns an output Event handle and an [[#IAsyncValue]].
Takes an input [[NCM_services#ApplicationId|ApplicationId]], returns an output Event handle and an [[#IAsyncResult]].


==== TouchApplication ====
See [[#RequestApplicationUpdateInfo]] regarding nifm.
Takes an input [[NCM_services#ApplicationId|ApplicationId]], no output.


==== IsApplicationUpdateRequested ====
==== GetApplicationControlProperty ====
Takes an input [[NCM_services#ApplicationId|ApplicationId]], returns an output u8 bool and an u32.
[18.0.0+] Now takes a total of 0x58 bytes of input.


The output u32 is only valid when the output bool is set.
==== ListApplicationTitle ====
Takes an input TransferMemory handle, a type-0x5 input buffer containing an array of u64 [[NCM_services#ApplicationId|ApplicationIds]], an u8 [[#ApplicationControlSource]], an u64 size, returns an output Event handle and an [[#IAsyncValue]].


==== WithdrawApplicationUpdateRequest ====
[[qlaunch]] uses value 0x1 for the u8.
Takes an input [[NCM_services#ApplicationId|ApplicationId]], no output.


==== RequestVerifyApplicationDeprecated ====
The user-process creates the TransferMemory with permissions=R--.
Takes an input TransferMemory handle, an [[NCM_services#ApplicationId|ApplicationId]], an u64 size, returns an output Event handle and an [[#IProgressAsyncResult]].


On newer system-versions this calls the same func as [[#RequestVerifyApplication]], with the u32 value set to 0x7.
The data available with [[#IAsyncValue]] Get is a s32 for the offset within the TransferMemory where the output data is located, GetSize returns the total byte-size of the data located here. The data located here is the [[NACP_Format|NACP]] title-entry for each specified ApplicationId.


==== RequestVerifyAddOnContentsRights ====
The TransferMemory size must be at least: count*sizeof([[NACP_Format|title-entry]]) + count*sizeof(u64) + count*[[#GetApplicationControlData|0x24000]].
Takes an input [[NCM_services#ApplicationId|ApplicationId]], returns an output Event handle and an [[#IProgressAsyncResult]].


==== RequestVerifyApplication ====
This is essentially an async wrapper for [[#GetApplicationControlData]], with support for multiple ApplicationIds.
Takes an input TransferMemory handle, an u32, an [[NCM_services#ApplicationId|ApplicationId]], an u64 size, returns an output Event handle and an [[#IProgressAsyncResult]].


Official sw creates the TransferMemory with an user-specified buffer with permissions=0. [[qlaunch]] uses buffer size 0x100000.
==== ListApplicationIcon ====
Takes an input TransferMemory handle, a type-0x5 input buffer containing an array of u64 [[NCM_services#ApplicationId|ApplicationIds]], an u8 [[#ApplicationControlSource]], an u64 size, returns an output Event handle and an [[#IAsyncValue]].


Official sw has an additional wrapper func which calls the original wrapper func, this uses value 0x7 for the u32. This is the same func used by [[qlaunch]].
The user-process creates the TransferMemory with permissions=R--.


==== IsAnyApplicationEntityInstalled ====
The data available with [[#IAsyncValue]] Get is a s32 for the offset within the TransferMemory where the output data is located, GetSize returns the total byte-size of the data located here. This data is: an u64 for total entries, an array of u64s for each icon size, then the icon JPEGs for the specified ApplicationIds.
Takes an input [[NCM_services#ApplicationId|ApplicationId]], returns an output u8 bool.


==== CleanupUnavailableAddOnContents ====
The TransferMemory size must be at least: 0x4 + count*sizeof(u64) + count*[[#GetApplicationControlData|0x20000]] + count*sizeof(u64) + [[#GetApplicationControlData|0x24000]].
Takes an input u64 [[NCM_services#ApplicationId|ApplicationId]], an [[Account_services#Uid|Uid]], no output.


==== RequestMoveApplicationEntity ====
This is essentially an async wrapper for [[#GetApplicationControlData]], with support for multiple ApplicationIds.
Takes an input TransferMemory handle, a type-0x5 input buffer containing an array of [[NCM_services#StorageId|StorageId]], a [[NCM_services#StorageId|StorageId]], an u32 bitfield of "nn::ns::KeepApplicationEntityFlagTag", an [[NCM_services#ApplicationId|ApplicationId]], an u64 tmem_size, returns an output Event handle and an [[#IProgressAsyncResult]].


The TransferMemory uses permissions=0.
==== RequestCheckGameCardRegistration ====
Takes an input [[NCM_services#ApplicationId|ApplicationId]], returns an output Event handle and an [[#IAsyncResult]].


==== EstimateSizeToMove ====
See [[#RequestApplicationUpdateInfo]] regarding nifm.
Takes a type-0x5 input buffer containing an array of [[NCM_services#StorageId|StorageId]], a [[NCM_services#StorageId|StorageId]], an u32 bitfield of "nn::ns::KeepApplicationEntityFlagTag", an [[NCM_services#ApplicationId|ApplicationId]], returns an output s64.


This calls a func also used by [[#RequestMoveApplicationEntity]], then calls another func.
==== RequestGameCardRegistrationGoldPoint ====
Takes an input [[Account_services#Uid|Uid]], an [[NCM_services#ApplicationId|ApplicationId]], returns an output Event handle and an [[#IAsyncValue]].


==== FormatSdCard ====
The data that can be read from the [[#IAsyncValue]] is 4-bytes.
No input/output.


==== NeedsSystemUpdateToFormatSdCard ====
See [[#RequestApplicationUpdateInfo]] regarding nifm.
No input, returns an output u8 bool.


==== GetLastSdCardFormatUnexpectedResult ====
==== RequestRegisterGameCard ====
No input/output.
Takes an input s32, an [[Account_services#Uid|Uid]], an [[NCM_services#ApplicationId|ApplicationId]], returns an output Event handle and an [[#IAsyncResult]].


==== GetApplicationView ====
See [[#RequestApplicationUpdateInfo]] regarding nifm.
Takes a type-0x6 output buffer containing an array of [[#ApplicationView]], a type-0x5 input buffer containing an array of u64 [[NCM_services#ApplicationId|ApplicationIds]], no output.


==== GetApplicationViewDownloadErrorContext ====
==== GetGameCardMountFailureEvent ====
Takes a type-0x16 output buffer containg an [[Error_Applet#ErrorContext|ErrorContext]], an u64 [[NCM_services#ApplicationId|ApplicationId]], no output.
No input, returns an output Event handle with EventClearMode=0.


==== GetApplicationViewWithPromotionInfo ====
==== IsGameCardInserted ====
Takes a type-0x6 output buffer containing an array of [[#ApplicationViewWithPromotionInfo]], a type-0x5 input buffer containing an array of u64 [[NCM_services#ApplicationId|ApplicationIds]], no output.
No input, returns an output u8 bool.


==== IsPatchAutoDeletableApplication ====
==== EnsureGameCardAccess ====
Takes an input [[NCM_services#ApplicationId|ApplicationId]], returns an output bool.
No input/output.


Compares the input ApplicationId with the value of [[System_Settings|system-setting]] <code>ns.application!auto_deletable_application_id_on_not_enough_space</code>, with the bool being set to the comparsion result.
==== GetLastGameCardMountFailureResult ====
No input/output.


==== RequestDownloadApplicationPrepurchasedRights ====
==== ListApplicationIdOnGameCard ====
Takes an input [[NCM_services#ApplicationId|ApplicationId]], returns an output Event handle and an [[#IAsyncResult]].
Takes a type-0x6 output buffer containing an array of u64 [[NCM_services#ApplicationId|ApplicationIds]], returns an output s32 for total output entries.


See [[#RequestApplicationUpdateInfo]] regarding nifm.
==== GetGameCardPlatformRegion ====
No input, returns an u8 '''GameCardPlatformRegion''' (0x00 = Global, 0x01 = China).


==== GetSystemDeliveryInfo ====
This calls [[Filesystem_services#IDeviceOperator|fsp-srv IDeviceOperator]] GetGameCardCompatibilityType and returns the result.
Takes a type-0x16 output buffer containing a [[#SystemDeliveryInfo]], no output.


This generates a [[#SystemDeliveryInfo]] using the currently installed SystemUpdate meta title.
==== ListAvailableAddOnContent ====
[10.0.0+] This now takes a total of 0x10-bytes of input instead of a total of 0x18-bytes of input.


==== SelectLatestSystemDeliveryInfo ====
[15.0.0+] This now takes a total of 0x8-bytes of input instead of a total of 0x10-bytes of input.
Takes a type-0x15 input buffer containing a [[#SystemDeliveryInfo]], a type-0x5 input buffer containing an array of [[#SystemDeliveryInfo]], a type-0x5 input buffer containing an array of [[#ApplicationDeliveryInfo]], and returns an output s32.


This determines the latest version from the input [[#ApplicationDeliveryInfo]] array, using value 0 if the array is empty. If this value is less than a state field, the state field value is used instead. Then this selects a [[#SystemDeliveryInfo]] with the latest version from the input array, where the minimum version is the previously mentioned value. The version must also be also be at least the version value from the type-0x15 [[#SystemDeliveryInfo]] buffer. This also does various validation, etc. The output s32 is an index in that array for the selected entry, -1 if none found.
==== RequestDownloadTaskListData ====
No input, returns an output Event handle and an [[#IAsyncValue]].


==== VerifyDeliveryProtocolVersion ====
==== TouchApplication ====
Takes a type-0x15 input buffer containing a [[#SystemDeliveryInfo]], no output.
Takes an input [[NCM_services#ApplicationId|ApplicationId]], no output.


This validates the [[#SystemDeliveryInfo]] HMAC and the protocol-version fields. Then the meta version is compared with a state field, an error is returned on match otherwise 0 is returned.
==== IsApplicationUpdateRequested ====
Takes an input [[NCM_services#ApplicationId|ApplicationId]], returns an output u8 bool and an u32.


==== GetApplicationDeliveryInfo ====
The output u32 is only valid when the output bool is set.
Takes a type-0x6 output buffer containing an array of [[#ApplicationDeliveryInfo]], an input u32 bitmask <code>nn::ns::ApplicationDeliveryAttributeTag</code>, an [[NCM_services#ApplicationId|ApplicationId]], and returns an output s32 total_out.


An error is thrown if any bit is set in ApplicationDeliveryAttributeTag besides bit1. The output array-count must be at least 1: only 1 entry will be written to this array (hence on success total_out will also only be 1 on success).
==== WithdrawApplicationUpdateRequest ====
Takes an input [[NCM_services#ApplicationId|ApplicationId]], no output.


==== HasAllContentsToDeliver ====
==== RequestVerifyApplicationDeprecated ====
Takes a type-0x5 input buffer containing an array of [[#ApplicationDeliveryInfo]], returns an output u8 bool.
Takes an input TransferMemory handle, an [[NCM_services#ApplicationId|ApplicationId]], an u64 size, returns an output Event handle and an [[#IProgressAsyncResult]].


The array-count must match 1. After validating the [[#ApplicationDeliveryInfo]], the output bool is set to u32 [[#ApplicationDeliveryInfo]]+0x1C & 0x10000002 != 0x2, then this returns 0.
On newer system-versions this calls the same func as [[#RequestVerifyApplication]], with the u32 value set to 0x7.


==== CompareApplicationDeliveryInfo ====
==== RequestVerifyAddOnContentsRights ====
Takes two type-0x5 input buffers containing an array of [[#ApplicationDeliveryInfo]], returns an output s32.
Takes an input [[NCM_services#ApplicationId|ApplicationId]], returns an output Event handle and an [[#IProgressAsyncResult]].


The array-count for both buffers must be 1, otherwise an error is returned.
==== RequestVerifyApplication ====
Takes an input TransferMemory handle, an u32, an [[NCM_services#ApplicationId|ApplicationId]], an u64 size, returns an output Event handle and an [[#IProgressAsyncResult]].


Both [[#ApplicationDeliveryInfo]] are validated, then the application-version in the first/second buffer are compared. The output s32 is set to the comparison result: -1 for less than, 0 for equal, and 1 for higher than.
Official sw creates the TransferMemory with an user-specified buffer with permissions=0. [[qlaunch]] uses buffer size 0x100000.


==== CanDeliverApplication ====
Official sw has an additional wrapper func which calls the original wrapper func, this uses value 0x7 for the u32. This is the same func used by [[qlaunch]].
Takes two type-0x5 input buffers containing an array of [[#ApplicationDeliveryInfo]], returns an output u8 bool.


The array-count for the second buffer must be 1 and the array-count for the first buffer must be <=1, otherwise an error is returned. If the array-count for the first buffer is 0, this will return 0 with the output bool set to 0.
==== IsAnyApplicationEntityInstalled ====
Takes an input [[NCM_services#ApplicationId|ApplicationId]], returns an output u8 bool.


==== ListContentMetaKeyToDeliverApplication ====
==== CleanupUnavailableAddOnContents ====
Takes a type-0x6 output buffer containing an array of [[NCM_services#ContentMetaKey|ContentMetaKey]], a type-0x5 input buffer containing an array of [[#ApplicationDeliveryInfo]], a s32, and returns an output s32 total_out.
Takes an input u64 [[NCM_services#ApplicationId|ApplicationId]], an [[Account_services#Uid|Uid]], no output.


The array-count for ContentMetaKey must be at least 1, and for ApplicationDeliveryInfo it must match 1.
==== RequestMoveApplicationEntity ====
Takes an input TransferMemory handle, a type-0x5 input buffer containing an array of [[NCM_services#StorageId|StorageId]], a [[NCM_services#StorageId|StorageId]], an u32 bitfield of "nn::ns::KeepApplicationEntityFlagTag", an [[NCM_services#ApplicationId|ApplicationId]], an u64 tmem_size, returns an output Event handle and an [[#IProgressAsyncResult]].
 
The TransferMemory uses permissions=0.
 
==== EstimateSizeToMove ====
Takes a type-0x5 input buffer containing an array of [[NCM_services#StorageId|StorageId]], a [[NCM_services#StorageId|StorageId]], an u32 bitfield of "nn::ns::KeepApplicationEntityFlagTag", an [[NCM_services#ApplicationId|ApplicationId]], returns an output s64.


This will only return 1 ContentMetaKey entry. This will not output the entry when the input s32 is larger than 0. This also does other validation, etc.
This calls a func also used by [[#RequestMoveApplicationEntity]], then calls another func.
 
==== FormatSdCard ====
No input/output.


==== NeedsSystemUpdateToDeliverApplication ====
==== NeedsSystemUpdateToFormatSdCard ====
Takes a type-0x15 input buffer containing a [[#SystemDeliveryInfo]], a type-0x5 input buffer containing an array of [[#ApplicationDeliveryInfo]], and returns an output u8 bool.
No input, returns an output u8 bool.


The array-count must match 1.
==== GetLastSdCardFormatUnexpectedResult ====
No input/output.


After validation etc, this sets the output bool by comparing system-version fields in the [[#SystemDeliveryInfo]]/[[#ApplicationDeliveryInfo]] and with a state field.
==== GetApplicationView ====
Takes a type-0x6 output buffer containing an array of [[#ApplicationView]], a type-0x5 input buffer containing an array of u64 [[NCM_services#ApplicationId|ApplicationIds]], no output.


==== EstimateRequiredSize ====
==== GetApplicationViewDownloadErrorContext ====
Takes a type-0x5 input buffer containing an array of [[NCM_services#ContentMetaKey|ContentMetaKey]], returns an output s64.
Takes a type-0x16 output buffer containg an [[Error_Applet#ErrorContext|ErrorContext]], an u64 [[NCM_services#ApplicationId|ApplicationId]], no output.


When the array-count is less than 1, this will return 0 with the s64 set to 0.
==== GetApplicationViewWithPromotionInfo ====
Takes a type-0x6 output buffer containing an array of [[#ApplicationViewWithPromotionInfo]], a type-0x5 input buffer containing an array of u64 [[NCM_services#ApplicationId|ApplicationIds]], no output.


==== RequestReceiveApplication ====
==== IsPatchAutoDeletableApplication ====
Takes a type-0x5 input buffer containing an array of [[NCM_services#ContentMetaKey|ContentMetaKey]], a [[NCM_services#StorageId|StorageId]], an u16 port, an u32 Ipv4Address, an [[NCM_services#ApplicationId|ApplicationId]], returns an output Event handle and an [[#IAsyncResult]].
Takes an input [[NCM_services#ApplicationId|ApplicationId]], returns an output bool.


[[qlaunch]] uses value Any for the StorageId, and value 55556 for the port.
Compares the input ApplicationId with the value of [[System_Settings|system-setting]] <code>ns.application!auto_deletable_application_id_on_not_enough_space</code>, with the bool being set to the comparsion result.


An error is thrown if a state ref-count is zero. An error is thrown if [[NIM_services|nim]] ListApplicationApplyDeltaTask returns a task.
==== ListLastNotificationInfo ====
Takes a type-0x6 buffer containing an array with struct entry size 0x90-bytes. Returns 4-bytes of output.


This loops through the input [[NCM_services#ContentMetaKey|ContentMetaKey]] array, throwing an error if the [[NCM_services#ContentMetaType|ContentMetaType]] doesn't match Patch. The input array is copied into state which is used later by the thread for [[NIM_services|nim]] cmd53, max entries is 0x12.
[19.0.0+] The struct size is now 0x98-bytes.


This does various setup then creates the [[#IAsyncResult]] + the async thread which handles the [[#IAsyncResult]] operation. Then the thread does:
==== ListNotificationTask ====
Takes a type-0x6 buffer containing an array with struct entry size 0xB0-bytes. Returns 4-bytes of output.


* Calls a func which does:
[19.0.0+] The struct size is now 0xB8-bytes.
** Throws an error if a state flag is set.
** Uses [[NIM_services|nim]] cmd53, returning the Result on failure.
** Uses [[NIM_services|nim]] cmd56, returning the Result on failure. Waits for the IAsyncResult operation from this to finish, then uses the Get cmd to get the output Result.
** Handles cleanup and returns.
* On success, this loads various data which is then used for saving a SystemPlayReport when the cached [[System_Settings|system-setting]] "systemreport!enabled" is set.
** The EventId is "receive_app_contents" with ApplicationId <NS ProgramId>.


==== CommitReceiveApplication ====
==== RequestDownloadApplicationPrepurchasedRights ====
Takes an input [[NCM_services#ApplicationId|ApplicationId]], no output.
Takes an input [[NCM_services#ApplicationId|ApplicationId]], returns an output Event handle and an [[#IAsyncResult]].


==== GetReceiveApplicationProgress ====
See [[#RequestApplicationUpdateInfo]] regarding nifm.
Takes an input [[NCM_services#ApplicationId|ApplicationId]], returns an output [[#ReceiveApplicationProgress]].


An error is thrown if a state ref-count is zero. An error is thrown if [[NIM_services|nim]] ListApplicationApplyDeltaTask returns a task.
==== GetSystemDeliveryInfo ====
Takes a type-0x16 output buffer containing a [[#SystemDeliveryInfo]], no output.


Uses [[NIM_services|nim]] cmd67, throwing an error if no task is returned. Then [[NIM_services|nim]] cmd57 is used, returning the error from there on failure. Lastly, this writes the 0x10-bytes from output+8 from the latter cmd to the output [[#ReceiveApplicationProgress]], and returns 0.
This generates a [[#SystemDeliveryInfo]] using the currently installed SystemUpdate meta title.


==== RequestSendApplication ====
==== SelectLatestSystemDeliveryInfo ====
Takes a type-0x5 input buffer containing an array of [[NCM_services#ContentMetaKey|ContentMetaKey]], an u16 port, an u32 Ipv4Address, an [[NCM_services#ApplicationId|ApplicationId]], returns an output Event handle and an [[#IAsyncResult]].
Takes a type-0x15 input buffer containing a [[#SystemDeliveryInfo]], a type-0x5 input buffer containing an array of [[#SystemDeliveryInfo]], a type-0x5 input buffer containing an array of [[#ApplicationDeliveryInfo]], and returns an output s32.


[[qlaunch]] uses value 55556 for the port.
This determines the latest version from the input [[#ApplicationDeliveryInfo]] array, using value 0 if the array is empty. If this value is less than a state field, the state field value is used instead. Then this selects a [[#SystemDeliveryInfo]] with the latest version from the input array, where the minimum version is the previously mentioned value. The version must also be also be at least the version value from the type-0x15 [[#SystemDeliveryInfo]] buffer. This also does various validation, etc. The output s32 is an index in that array for the selected entry, -1 if none found.


An error is thrown if a state ref-count is zero. An error is thrown if [[NIM_services|nim]] ListApplicationApplyDeltaTask returns a task.
==== VerifyDeliveryProtocolVersion ====
Takes a type-0x15 input buffer containing a [[#SystemDeliveryInfo]], no output.


The [[NCM_services#ContentMetaType|ContentMetaType]] must match Patch.
This validates the [[#SystemDeliveryInfo]] HMAC and the protocol-version fields. Then the meta version is compared with a state field, an error is returned on match otherwise 0 is returned.


This does various setup and selects a ContentMetaKey to use from the input, then creates the [[#IAsyncResult]] + the async thread which handles the [[#IAsyncResult]] operation. Then the thread does:
==== GetApplicationDeliveryInfo ====
Takes a type-0x6 output buffer containing an array of [[#ApplicationDeliveryInfo]], an input u32 bitmask <code>nn::ns::ApplicationDeliveryAttributeTag</code>, an [[NCM_services#ApplicationId|ApplicationId]], and returns an output s32 total_out.


* Calls a func which does:
An error is thrown if any bit is set in ApplicationDeliveryAttributeTag besides bit1. The output array-count must be at least 1: only 1 entry will be written to this array (hence on success total_out will also only be 1 on success).
** Throws an error if a state flag is set.
** Uses [[NIM_services|nim]] cmd60, returning the Result on failure.
** Uses [[NIM_services|nim]] cmd61, returning the Result on failure. Waits for the IAsyncResult operation from this to finish, then uses the Get cmd to get the output Result.
** Handles cleanup and returns.
* On success, this loads various data which is then used for saving a SystemPlayReport when the cached [[System_Settings|system-setting]] "systemreport!enabled" is set.
** The EventId is "send_app_contents" with ApplicationId <NS ProgramId>.


==== GetSendApplicationProgress ====
==== HasAllContentsToDeliver ====
Takes an input [[NCM_services#ApplicationId|ApplicationId]], returns an output [[#SendApplicationProgress]].
Takes a type-0x5 input buffer containing an array of [[#ApplicationDeliveryInfo]], returns an output u8 bool.


Same as [[#GetReceiveApplicationProgress]] except this is the Send version, and uses [[NIM_services|nim]] cmd68/cmd63 instead.
The array-count must match 1. After validating the [[#ApplicationDeliveryInfo]], the output bool is set to u32 [[#ApplicationDeliveryInfo]]+0x1C & 0x10000002 != 0x2, then this returns 0.


==== CompareSystemDeliveryInfo ====
==== CompareApplicationDeliveryInfo ====
Takes two type-0x15 input buffers containing a [[#SystemDeliveryInfo]], returns an output s32.
Takes two type-0x5 input buffers containing an array of [[#ApplicationDeliveryInfo]], returns an output s32.


This is essentially the same as [[#CompareApplicationDeliveryInfo]], except this compares the [[#SystemDeliveryInfo]] SystemUpdate version.
The array-count for both buffers must be 1, otherwise an error is returned.


==== ListNotCommittedContentMeta ====
Both [[#ApplicationDeliveryInfo]] are validated, then the application-version in the first/second buffer are compared. The output s32 is set to the comparison result: -1 for less than, 0 for equal, and 1 for higher than.
Takes a type-0x6 output buffer containing an array of [[NCM_services#ContentMetaKey|ContentMetaKey]], a s32, an [[NCM_services#ApplicationId|ApplicationId]], returns an output s32 total_out.


==== RecoverDownloadTask ====
==== CanDeliverApplication ====
Takes a type-0x5 input buffer containing an array of {unknown} and an input u64, no output.
Takes two type-0x5 input buffers containing an array of [[#ApplicationDeliveryInfo]], returns an output u8 bool.


==== GetApplicationDeliveryInfoHash ====
The array-count for the second buffer must be 1 and the array-count for the first buffer must be <=1, otherwise an error is returned. If the array-count for the first buffer is 0, this will return 0 with the output bool set to 0.
Takes a type-0x5 input buffer containing an array of [[#ApplicationDeliveryInfo]], returns an output 0x20-byte SHA256 hash.


This extracts data from the input array for hashing with SHA256, with validation being done when handling each entry.
==== ListContentMetaKeyToDeliverApplication ====
Takes a type-0x6 output buffer containing an array of [[NCM_services#ContentMetaKey|ContentMetaKey]], a type-0x5 input buffer containing an array of [[#ApplicationDeliveryInfo]], a s32, and returns an output s32 total_out.


==== GetApplicationRightsOnClient ====
The array-count for ContentMetaKey must be at least 1, and for ApplicationDeliveryInfo it must match 1.
Takes a type-0x6 output buffer containing an array of [[#ApplicationRightsOnClient]], an input u32 flags, an [[NCM_services#ApplicationId|ApplicationId]], an [[Account_services#Uid|Uid]], returns 4-bytes of output for total output entries.


Official sw has at least two wrappers which use this cmd: one with an all-zero Uid, one with an user-specified Uid. With both of these, the passed flags are hard-coded to value 0x3.
This will only return 1 ContentMetaKey entry. This will not output the entry when the input s32 is larger than 0. This also does other validation, etc.


For the output array count, [[qlaunch]] uses value 3.
==== NeedsSystemUpdateToDeliverApplication ====
Takes a type-0x15 input buffer containing a [[#SystemDeliveryInfo]], a type-0x5 input buffer containing an array of [[#ApplicationDeliveryInfo]], and returns an output u8 bool.


==== GetApplicationTerminateResult ====
The array-count must match 1.
Takes an input [[NCM_services#ApplicationId|ApplicationId]], returns an output u32 Result.


==== GetRightsEnvironmentHandleForApplication ====
After validation etc, this sets the output bool by comparing system-version fields in the [[#SystemDeliveryInfo]]/[[#ApplicationDeliveryInfo]] and with a state field.
No input, returns a total of 8-bytes of output.


[9.0.0+] Now takes a total of 8-bytes of input, returns a total of 8-bytes of output.
==== EstimateRequiredSize ====
Takes a type-0x5 input buffer containing an array of [[NCM_services#ContentMetaKey|ContentMetaKey]], returns an output s64.


==== RequestNoDownloadRightsErrorResolution ====
When the array-count is less than 1, this will return 0 with the s64 set to 0.
Takes an input [[NCM_services#ApplicationId|ApplicationId]], returns an output Event handle and an [[#IAsyncValue]].


The data that can be read from the [[#IAsyncValue]] is [[#NoDownloadRightsErrorResolution]].
==== RequestReceiveApplication ====
Takes a type-0x5 input buffer containing an array of [[NCM_services#ContentMetaKey|ContentMetaKey]], a [[NCM_services#StorageId|StorageId]], an u16 port, an u32 Ipv4Address, an [[NCM_services#ApplicationId|ApplicationId]], returns an output Event handle and an [[#IAsyncResult]].


See [[#RequestApplicationUpdateInfo]] regarding nifm.
[[qlaunch]] uses value Any for the StorageId, and value 55556 for the port.


==== RequestResolveNoDownloadRightsError ====
An error is thrown if a state ref-count is zero. An error is thrown if [[NIM_services|nim]] ListApplicationApplyDeltaTask returns a task.
Takes an input [[NCM_services#ApplicationId|ApplicationId]], returns an output Event handle and an [[#IAsyncValue]].


The data that can be read from the [[#IAsyncValue]] is [[#NoDownloadRightsErrorResolution]].
This loops through the input [[NCM_services#ContentMetaKey|ContentMetaKey]] array, throwing an error if the [[NCM_services#ContentMetaType|ContentMetaType]] doesn't match Patch. The input array is copied into state which is used later by the thread for [[NIM_services|nim]] cmd53, max entries is 0x12.


See [[#RequestApplicationUpdateInfo]] regarding nifm.
This does various setup then creates the [[#IAsyncResult]] + the async thread which handles the [[#IAsyncResult]] operation. Then the thread does:


==== GetPromotionInfo ====
* Calls a func which does:
Takes a type-0x6 output buffer containing an array of [[#PromotionInfo]], a type-0x5 input buffer containing an array of u64 [[NCM_services#ApplicationId|ApplicationIds]], a type-0x5 input buffer containing an array of [[Account_services#Uid|Uids]], no output.
** Throws an error if a state flag is set.
** Uses [[NIM_services|nim]] cmd53, returning the Result on failure.
** Uses [[NIM_services|nim]] cmd56, returning the Result on failure. Waits for the IAsyncResult operation from this to finish, then uses the Get cmd to get the output Result.
** Handles cleanup and returns.
* On success, this loads various data which is then used for saving a SystemPlayReport when the cached [[System_Settings|system-setting]] "systemreport!enabled" is set.
** The EventId is "receive_app_contents" with ApplicationId <NS ProgramId>.


Official sw uses hard-coded value 1 for the count with each of these arrays.
==== CommitReceiveApplication ====
Takes an input [[NCM_services#ApplicationId|ApplicationId]], no output.


==== ImportPromotionJsonForDebug ====
==== GetReceiveApplicationProgress ====
Takes a type-0x5 input buffer, no output.
Takes an input [[NCM_services#ApplicationId|ApplicationId]], returns an output [[#ReceiveApplicationProgress]].


The output from [[Settings_services#GetDebugModeFlag]] must be 1, otherwise an error is returned.
An error is thrown if a state ref-count is zero. An error is thrown if [[NIM_services|nim]] ListApplicationApplyDeltaTask returns a task.


==== ClearPromotionInfoForDebug ====
Uses [[NIM_services|nim]] cmd67, throwing an error if no task is returned. Then [[NIM_services|nim]] cmd57 is used, returning the error from there on failure. Lastly, this writes the 0x10-bytes from output+8 from the latter cmd to the output [[#ReceiveApplicationProgress]], and returns 0.
No input/output.


The output from [[Settings_services#GetDebugModeFlag]] must be 1, otherwise an error is returned.
==== RequestSendApplication ====
Takes a type-0x5 input buffer containing an array of [[NCM_services#ContentMetaKey|ContentMetaKey]], an u16 port, an u32 Ipv4Address, an [[NCM_services#ApplicationId|ApplicationId]], returns an output Event handle and an [[#IAsyncResult]].


This just clears 0xC-bytes in state.
[[qlaunch]] uses value 55556 for the port.


==== CreateApplicationResource ====
An error is thrown if a state ref-count is zero. An error is thrown if [[NIM_services|nim]] ListApplicationApplyDeltaTask returns a task.
Returns an [[#IApplicationResource]].


==== GetApplicationResource ====
The [[NCM_services#ContentMetaType|ContentMetaType]] must match Patch.
Returns an [[#IApplicationResource]].


==== RegisterDeviceLockKey ====
This does various setup and selects a ContentMetaKey to use from the input, then creates the [[#IAsyncResult]] + the async thread which handles the [[#IAsyncResult]] operation. Then the thread does:
Takes a type-0x5 input buffer containing an InArray of u8, no output.


User-processes expose this with two funcs: one which uses an user-specified u8 array directly, while the other uses [[HID_services#NpadButtonSet|NpadButton]].
* Calls a func which does:
** Throws an error if a state flag is set.
** Uses [[NIM_services|nim]] cmd60, returning the Result on failure.
** Uses [[NIM_services|nim]] cmd61, returning the Result on failure. Waits for the IAsyncResult operation from this to finish, then uses the Get cmd to get the output Result.
** Handles cleanup and returns.
* On success, this loads various data which is then used for saving a SystemPlayReport when the cached [[System_Settings|system-setting]] "systemreport!enabled" is set.
** The EventId is "send_app_contents" with ApplicationId <NS ProgramId>.


This does SHA256 hashing, etc.
==== GetSendApplicationProgress ====
Takes an input [[NCM_services#ApplicationId|ApplicationId]], returns an output [[#SendApplicationProgress]].


==== UnregisterDeviceLockKey ====
Same as [[#GetReceiveApplicationProgress]] except this is the Send version, and uses [[NIM_services|nim]] cmd68/cmd63 instead.
No input/output.


Runs code identical to [[#RegisterDeviceLockKey]], except the passed buffer/size are 0.
==== CompareSystemDeliveryInfo ====
Takes two type-0x15 input buffers containing a [[#SystemDeliveryInfo]], returns an output s32.


==== VerifyDeviceLockKey ====
This is essentially the same as [[#CompareApplicationDeliveryInfo]], except this compares the [[#SystemDeliveryInfo]] SystemUpdate version.
Takes a type-0x5 input buffer containing an InArray of u8, no output.


User-processes expose this with two funcs: one which uses an user-specified u8 array directly, while the other uses [[HID_services#NpadButtonSet|NpadButton]].
==== ListNotCommittedContentMeta ====
Takes a type-0x6 output buffer containing an array of [[NCM_services#ContentMetaKey|ContentMetaKey]], a s32, an [[NCM_services#ApplicationId|ApplicationId]], returns an output s32 total_out.


This runs hashing similar to [[#RegisterDeviceLockKey]], with the calculated hash being verified with the one from state.
==== RecoverDownloadTask ====
Takes a type-0x5 input buffer containing an array of {unknown} and an input u64, no output.


==== HideApplicationIcon ====
==== GetApplicationDeliveryInfoHash ====
No input/output.
Takes a type-0x5 input buffer containing an array of [[#ApplicationDeliveryInfo]], returns an output 0x20-byte SHA256 hash.


==== ShowApplicationIcon ====
This extracts data from the input array for hashing with SHA256, with validation being done when handling each entry.
No input/output.


==== HideApplicationTitle ====
==== GetApplicationRightsOnClient ====
No input/output.
Takes a type-0x6 output buffer containing an array of [[#ApplicationRightsOnClient]], an input u32 flags, an [[NCM_services#ApplicationId|ApplicationId]], an [[Account_services#Uid|Uid]], returns 4-bytes of output for total output entries.


==== ShowApplicationTitle ====
Official sw has at least two wrappers which use this cmd: one with an all-zero Uid, one with an user-specified Uid. With both of these, the passed flags are hard-coded to value 0x3.
No input/output.


==== EnableGameCard ====
For the output array count, [[qlaunch]] uses value 3.
No input/output.


==== DisableGameCard ====
==== GetApplicationTerminateResult ====
No input/output.
Takes an input [[NCM_services#ApplicationId|ApplicationId]], returns an output u32 Result.


==== EnableLocalContentShare ====
==== GetRightsEnvironmentHandleForApplication ====
No input/output.
No input, returns a total of 8-bytes of output.


==== DisableLocalContentShare ====
[9.0.0+] Now takes a total of 8-bytes of input, returns a total of 8-bytes of output.
No input/output.


==== IsApplicationIconHidden ====
==== RequestNoDownloadRightsErrorResolution ====
No input, returns an output bool.
Takes an input [[NCM_services#ApplicationId|ApplicationId]], returns an output Event handle and an [[#IAsyncValue]].


==== IsApplicationTitleHidden ====
The data that can be read from the [[#IAsyncValue]] is [[#NoDownloadRightsErrorResolution]].
No input, returns an output bool.


==== IsGameCardEnabled ====
See [[#RequestApplicationUpdateInfo]] regarding nifm.
No input, returns an output bool.


==== IsLocalContentShareEnabled ====
==== RequestResolveNoDownloadRightsError ====
No input, returns an output bool.
Takes an input [[NCM_services#ApplicationId|ApplicationId]], returns an output Event handle and an [[#IAsyncValue]].


Various Deliver cmds now load the same flag used by this cmd (IsLocalContentShareEnabled), with an error being returned when it's not enabled.
The data that can be read from the [[#IAsyncValue]] is [[#NoDownloadRightsErrorResolution]].


=== IGameCardStopper ===
See [[#RequestApplicationUpdateInfo]] regarding nifm.
This is "nn::ns::detail::IGameCardStopper".
 
==== GetPromotionInfo ====
Takes a type-0x6 output buffer containing an array of [[#PromotionInfo]], a type-0x5 input buffer containing an array of u64 [[NCM_services#ApplicationId|ApplicationIds]], a type-0x5 input buffer containing an array of [[Account_services#Uid|Uids]], no output.


This interface has no commands.
Official sw uses hard-coded value 1 for the count with each of these arrays.


=== IRequestServerStopper ===
==== ListPromotionInfo ====
This is "nn::ns::detail::IRequestServerStopper".
[20.0.0+] The struct size for the output buffer array is now 0x28-bytes instead of 0x20-bytes.


This interface has no commands.
==== ImportPromotionJsonForDebug ====
Takes a type-0x5 input buffer, no output.


=== IProgressMonitorForDeleteUserSaveDataAll ===
The output from [[Settings_services#GetDebugModeFlag]] must be 1, otherwise an error is returned.
This is "nn::ns::detail::IProgressMonitorForDeleteUserSaveDataAll".


{| class="wikitable" border="1"
==== ClearPromotionInfoForDebug ====
|-
No input/output.
! Cmd || Name
|-
| 0 || GetSystemEvent
|-
| 1 || IsFinished
|-
| 2 || GetResult
|-
| 10 || GetProgress
|}


When closing the object, official sw uses IsFinished first, asserting when the output bool is false.
The output from [[Settings_services#GetDebugModeFlag]] must be 1, otherwise an error is returned.


* GetSystemEvent: No input, returns an output Event handle. [[qlaunch]] doesn't use this.
This just clears 0xC-bytes in state.


* IsFinished: No input, returns an output u8 bool.
==== CreateApplicationResource ====
Takes an input [[#ApplicationResourceType]]. Returns an [[#IApplicationResource]].


* GetResult: No input/output.
==== GetApplicationResource ====
Takes an input u64 ProcessId and an input [[#ApplicationResourceType]]. Returns an [[#IApplicationResource]].


* GetProgress: No input, returns an output [[#ProgressForDeleteUserSaveDataAll]]. Official sw writes this struct directly to object state.
==== LaunchMicroApplication ====
[18.0.0+] Now takes a total of 0x50 bytes of input.


=== IProgressAsyncResult ===
[19.0.0+] Now takes a total of 0x80 bytes of input.
This is "nn::ns::detail::IProgressAsyncResult".


{| class="wikitable" border="1"
==== CreateApplicationInstance ====
|-
[18.0.0+] Now takes a total of 0x50 bytes of input.
! Cmd || Name
 
|-
[19.0.0+] Now takes a total of 0x80 bytes of input.
| 0 || Get
 
|-
==== RegisterDeviceLockKey ====
| 1 || Cancel
Takes a type-0x5 input buffer containing an InArray of u8, no output.
|-
 
| 2 || GetProgress
User-processes expose this with two funcs: one which uses an user-specified u8 array directly, while the other uses [[HID_services#NpadButtonSet|NpadButton]].
|-
 
| 3 || GetDetailResult
This does SHA256 hashing, etc.
|-
| 4 || [4.0.0+] GetErrorContext
|}


=== IApplicationVersionInterface ===
==== UnregisterDeviceLockKey ====
This is "nn::ns::detail::IApplicationVersionInterface".
No input/output.


This was added with [4.0.0+].
Runs code identical to [[#RegisterDeviceLockKey]], except the passed buffer/size are 0.


{| class="wikitable" border="1"
==== VerifyDeviceLockKey ====
|-
Takes a type-0x5 input buffer containing an InArray of u8, no output.
! Cmd || Name
 
|-
User-processes expose this with two funcs: one which uses an user-specified u8 array directly, while the other uses [[HID_services#NpadButtonSet|NpadButton]].
| 0 || GetLaunchRequiredVersion
 
|-
This runs hashing similar to [[#RegisterDeviceLockKey]], with the calculated hash being verified with the one from state.
| 1 || UpgradeLaunchRequiredVersion
|-
| 35 || UpdateVersionList
|-
| 36 || PushLaunchVersion
|-
| 37 || ListRequiredVersion
|-
| 800 || RequestVersionList
|-
| 801 || ListVersionList
|-
| 802 || [[#RequestVersionListData]]
|-
| 900 || [12.0.0+] ImportAutoUpdatePolicyJsonForDebug
|-
| 901 || [12.0.0+] ListDefaultAutoUpdatePolicy
|-
| 902 || [12.0.0+] ListAutoUpdatePolicyForSpecificApplication
|-
| 1000 || PerformAutoUpdate
|-
| 1001 || [11.0.0+] ListAutoUpdateSchedule
|}


==== RequestVersionListData ====
==== HideApplicationIcon ====
No input, returns an output Event handle and an [[#IAsyncValue]].
No input/output.


The data that can be read from the [[#IAsyncValue]] is [[#VersionListData]].
==== ShowApplicationIcon ====
No input/output.


=== IContentManagementInterface ===
==== HideApplicationTitle ====
This is "nn::ns::detail::IContentManagementInterface".
No input/output.


{| class="wikitable" border="1"
==== ShowApplicationTitle ====
|-
No input/output.
! Cmd || Name
|-
| 11 || [[#CalculateApplicationOccupiedSize]]
|-
| 43 || [[#CheckSdCardMountStatus]]
|-
| 47 || [[#GetTotalSpaceSize]]
|-
| 48 || [[#GetFreeSpaceSize]]
|-
| 600 || [[#CountApplicationContentMeta]]
|-
| 601 || [[#ListApplicationContentMetaStatus]]
|-
| 605 || [[#ListApplicationContentMetaStatusWithRightsCheck]]
|-
| 607 || [[#IsAnyApplicationRunning]]
|}


==== CalculateApplicationOccupiedSize ====
==== EnableGameCard ====
Takes an input [[NCM_services#ApplicationId|ApplicationId]], returns an output [[#ApplicationOccupiedSize]].
No input/output.


==== CheckSdCardMountStatus ====
==== DisableGameCard ====
No input/output.
No input/output.


==== CountApplicationContentMeta ====
==== EnableLocalContentShare ====
Takes an input [[NCM_services#ApplicationId|ApplicationId]], returns an output s32.
No input/output.


==== ListApplicationContentMetaStatusWithRightsCheck ====
==== DisableLocalContentShare ====
Same input/output as [[#ListApplicationContentMetaStatus]].
No input/output.


==== IsAnyApplicationRunning ====
==== IsApplicationIconHidden ====
No input, returns an output u8 bool.
No input, returns an output bool.


=== IDocumentInterface ===
==== IsApplicationTitleHidden ====
This is "nn::ns::detail::IDocumentInterface".
No input, returns an output bool.


{| class="wikitable" border="1"
==== IsGameCardEnabled ====
|-
No input, returns an output bool.
! Cmd || Name
 
|-
==== IsLocalContentShareEnabled ====
| 21 || GetApplicationContentPath
No input, returns an output bool.
|-
 
| 23 || ResolveApplicationContentPath
Various Deliver cmds now load the same flag used by this cmd (IsLocalContentShareEnabled), with an error being returned when it's not enabled.
|-
 
| 92 || [5.0.0+] GetRunningApplicationProgramId
=== IGameCardStopper ===
|}
This is "nn::ns::detail::IGameCardStopper".
 
This interface has no commands.
 
=== IRequestServerStopper ===
This is "nn::ns::detail::IRequestServerStopper".
 
This interface has no commands.


=== IDownloadTaskInterface ===
=== IProgressMonitorForDeleteUserSaveDataAll ===
This is "nn::ns::detail::IDownloadTaskInterface".
This is "nn::ns::detail::IProgressMonitorForDeleteUserSaveDataAll".


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 1,781: Line 1,918:
! Cmd || Name
! Cmd || Name
|-
|-
| 701 || [[#ClearTaskStatusList]]
| 0 || GetSystemEvent
|-
|-
| 702 || [[#RequestDownloadTaskList]]
| 1 || IsFinished
|-
|-
| 703 || [[#RequestEnsureDownloadTask]]
| 2 || GetResult
|-
|-
| 704 || [[#ListDownloadTaskStatus]]
| 10 || GetProgress
|-
|}
| 705 || [[#RequestDownloadTaskListData]]
 
When closing the object, official sw uses IsFinished first, asserting when the output bool is false.
 
* GetSystemEvent: No input, returns an output Event handle. [[qlaunch]] doesn't use this.
 
* IsFinished: No input, returns an output u8 bool.
 
* GetResult: No input/output.
 
* GetProgress: No input, returns an output [[#ProgressForDeleteUserSaveDataAll]]. Official sw writes this struct directly to object state.
 
=== IProgressAsyncResult ===
This is "nn::ns::detail::IProgressAsyncResult".
 
{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || Get
|-
|-
| 706 || [4.0.0+] [[#TryCommitCurrentApplicationDownloadTask]]
| 1 || Cancel
|-
|-
| 707 || [4.0.0+] [[#EnableAutoCommit]]
| 2 || GetProgress
|-
|-
| 708 || [4.0.0+] [[#DisableAutoCommit]]
| 3 || GetDetailResult
|-
|-
| 709 || [4.0.0+] [[#TriggerDynamicCommitEvent]]
| 4 || [4.0.0+] GetErrorContext
|}
|}


==== ClearTaskStatusList ====
=== IApplicationVersionInterface ===
No input/output.
This is "nn::ns::detail::IApplicationVersionInterface".


==== RequestDownloadTaskList ====
This was added with [4.0.0+].
No input/output.


==== RequestEnsureDownloadTask ====
{| class="wikitable" border="1"
No input, returns an output Event handle and an [[#IAsyncResult]].
|-
 
! Cmd || Name
==== ListDownloadTaskStatus ====
Takes a type-0x6 output buffer containing an array of [[#DownloadTaskStatus]], returns an output s32 total_out.
 
A maximum of 0x100 tasks can be stored in state.
 
==== TryCommitCurrentApplicationDownloadTask ====
No input/output.
 
==== EnableAutoCommit ====
No input/output.
 
==== DisableAutoCommit ====
No input/output.
 
==== TriggerDynamicCommitEvent ====
No input/output.
 
=== IReadOnlyApplicationRecordInterface ===
This is "nn::ns::detail::IReadOnlyApplicationRecordInterface".
 
This was added with [5.0.0+].
 
{| class="wikitable" border="1"
|-
|-
! Cmd || Name || Notes
| 0 || GetLaunchRequiredVersion
|-
|-
| 0 || HasApplicationRecord || Same as [[#IApplicationManagerInterface]] cmd 910
| 1 || UpgradeLaunchRequiredVersion
|-
|-
| 1 || [10.0.0+] NotifyApplicationFailure ||
| 35 || UpdateVersionList
|-
|-
| 2 || [10.0.0+] IsDataCorruptedResult ||
| 36 || PushLaunchVersion
|}
 
=== IReadOnlyApplicationControlDataInterface ===
This is "nn::ns::detail::IReadOnlyApplicationControlDataInterface".
 
This was added with [5.1.0+].
 
{| class="wikitable" border="1"
|-
|-
! Cmd || Name || Notes
| 37 || ListRequiredVersion
|-
| 800 || RequestVersionList
|-
| 801 || ListVersionList
|-
| 802 || [[#RequestVersionListData]]
|-
|-
| 0 || [[#GetApplicationControlData]] || Same as [[#IApplicationManagerInterface]] cmd 400
| 900 || [12.0.0+] ImportAutoUpdatePolicyJsonForDebug
|-
|-
| 1 || [[#GetApplicationDesiredLanguage]] || Same as [[#IApplicationManagerInterface]] cmd 55
| 901 || [12.0.0+] ListDefaultAutoUpdatePolicy
|-
|-
| 2 || ConvertApplicationLanguageToLanguageCode || Same as [[#IApplicationManagerInterface]] cmd 59
| 902 || [12.0.0+] ListAutoUpdatePolicyForSpecificApplication
|-
|-
| 3 || [[#ConvertLanguageCodeToApplicationLanguage]] || Same as [[#IApplicationManagerInterface]] cmd 60
| 1000 || PerformAutoUpdate
|-
|-
| 4 || [9.0.0+] SelectApplicationDesiredLanguage ||
| 1001 || [11.0.0+] ListAutoUpdateSchedule
|}
|}


=== IDynamicRightsInterface ===
==== RequestVersionListData ====
This is "nn::ns::detail::IDynamicRightsInterface".
No input, returns an output Event handle and an [[#IAsyncValue]].
 
The data that can be read from the [[#IAsyncValue]] is [[#VersionListData]].


This was added with [6.0.0+].
=== IContentManagementInterface ===
This is "nn::ns::detail::IContentManagementInterface".


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 1,871: Line 2,003:
! Cmd || Name
! Cmd || Name
|-
|-
| 0 || [[#RequestApplicationRightsOnServer]]
| 11 || [[#CalculateApplicationOccupiedSize]]
|-
|-
| 1 || [[#RequestAssignRights]]
| 43 || [[#CheckSdCardMountStatus]]
|-
|-
| 4 || [[#DeprecatedRequestAssignRightsToResume]]
| 47 || [[#GetTotalSpaceSize]]
|-
|-
| 5 || [[#VerifyActivatedRightsOwners]]
| 48 || [[#GetFreeSpaceSize]]
|-
|-
| 6 || [[#DeprecatedGetApplicationRightsStatus]]
| 58 || [20.1.0+]
|-
|-
| 7 || [[#RequestPrefetchForDynamicRights]]
| 71 || [20.1.0+]
|-
|-
| 8 || [[#GetDynamicRightsState]]
| 600 || [[#CountApplicationContentMeta]]
|-
|-
| 9 || [7.0.0+] [[#RequestApplicationRightsOnServerToResume]]
| 601 || [[#ListApplicationContentMetaStatus]]
|-
|-
| 10 || [7.0.0+] [[#RequestAssignRightsToResume]]
| 605 || [[#ListApplicationContentMetaStatusWithRightsCheck]]
|-
|-
| 11 || [7.0.0+] [[#GetActivatedRightsUsers]]
| 607 || [[#IsAnyApplicationRunning]]
|}
 
==== CalculateApplicationOccupiedSize ====
Takes an input [[NCM_services#ApplicationId|ApplicationId]], returns an output [[#ApplicationOccupiedSize]].
 
==== CheckSdCardMountStatus ====
No input/output.
 
==== CountApplicationContentMeta ====
Takes an input [[NCM_services#ApplicationId|ApplicationId]], returns an output s32.
 
==== ListApplicationContentMetaStatusWithRightsCheck ====
Same input/output as [[#ListApplicationContentMetaStatus]].
 
==== IsAnyApplicationRunning ====
No input, returns an output u8 bool.
 
=== IDocumentInterface ===
This is "nn::ns::detail::IDocumentInterface".
 
{| class="wikitable" border="1"
|-
|-
| 12 || [8.0.0+] [[#GetApplicationRightsStatus]]
! Cmd || Name
|-
|-
| 13 || [8.0.0+] [[#GetRunningApplicationStatus]]
| 21 || GetApplicationContentPath
|-
|-
| 14 || [10.0.0+] SelectApplicationLicense
| 23 || ResolveApplicationContentPath
|-
|-
| 15 || [12.0.0+] [[#RequestContentsAuthorizationToken]]
| 92 || [5.0.0+] GetRunningApplicationProgramId
|-
|-
| 16 || [13.0.0+] QualifyUser
| 2524 || [19.0.0+]  
|}
 
=== IDownloadTaskInterface ===
This is "nn::ns::detail::IDownloadTaskInterface".
 
{| class="wikitable" border="1"
|-
|-
| 17 || [13.0.0+] QualifyUserWithProcessId
! Cmd || Name
|-
| 701 || [[#ClearTaskStatusList]]
|-
| 702 || [[#RequestDownloadTaskList]]
|-
|-
| 18 || [13.0.0+] NotifyApplicationRightsCheckStart
| 703 || [[#RequestEnsureDownloadTask]]
|-
|-
| 19 || [13.0.0+] UpdateUserList
| 704 || [[#ListDownloadTaskStatus]]
|-
|-
| 20 || [13.0.0+] IsRightsLostUser
| 705 || [[#RequestDownloadTaskListData]]
|-
|-
| 21 || [13.1.0+] SetRequiredAddOnContentsOnContentsAvailabilityTransition
| 706 || [4.0.0+] [[#TryCommitCurrentApplicationDownloadTask]]
|-
|-
| 22 || [14.0.0+] GetLimitedApplicationLicense
| 707 || [4.0.0+] [[#EnableAutoCommit]]
|-
|-
| 23 || [14.0.0+] GetLimitedApplicationLicenseUpgradableEvent
| 708 || [4.0.0+] [[#DisableAutoCommit]]
|-
|-
| 24 || [14.0.0+] NotifyLimitedApplicationLicenseUpgradableEventForDebug
| 709 || [4.0.0+] [[#TriggerDynamicCommitEvent]]
|-
|-
| 25 || [14.0.0+] RequestProceedDynamicRightsState
| 710 || [20.0.0+]
|}
|}


==== RequestApplicationRightsOnServer ====
==== ClearTaskStatusList ====
Takes an input [[NCM_services#ApplicationId|ApplicationId]], an [[Account_services#Uid|Uid]] and an u32. Returns an output Event handle and an [[#IAsyncValue]].
No input/output.


==== RequestAssignRights ====
==== RequestDownloadTaskList ====
Takes a type-0x5 input buffer containing an array of "nn::ns::ApplicationRightsOnServer". Returns an output Event handle and an [[#IAsyncResult]].
No input/output.


==== DeprecatedRequestAssignRightsToResume ====
==== RequestEnsureDownloadTask ====
Takes an input u64 "nn::ns::RightsEnvironmentHandle" and an [[Account_services#Uid|Uid]]. Returns an output Event handle and an [[#IAsyncResult]].
No input, returns an output Event handle and an [[#IAsyncResult]].


==== VerifyActivatedRightsOwners ====
==== ListDownloadTaskStatus ====
Takes an input u64 "nn::ns::RightsEnvironmentHandle". No output.
Takes a type-0x6 output buffer containing an array of [[#DownloadTaskStatus]], returns an output s32 total_out.


==== DeprecatedGetApplicationRightsStatus ====
A maximum of 0x100 tasks can be stored in state.
Takes an input u64 "nn::ns::RightsEnvironmentHandle". Returns a bool "nn::ns::ApplicationRightsStatus".


==== RequestPrefetchForDynamicRights ====
==== TryCommitCurrentApplicationDownloadTask ====
Takes an input [[Account_services#Uid|Uid]]. Returns an output Event handle and an [[#IAsyncResult]].
No input/output.


==== GetDynamicRightsState ====
==== EnableAutoCommit ====
No input. Returns a bool "nn::ns::DynamicRightsState".
No input/output.


==== RequestApplicationRightsOnServerToResume ====
==== DisableAutoCommit ====
Takes an input u64 "nn::ns::RightsEnvironmentHandle". Returns an output Event handle and an [[#IAsyncValue]].
No input/output.


==== RequestAssignRightsToResume ====
==== TriggerDynamicCommitEvent ====
Takes an input u64 "nn::ns::RightsEnvironmentHandle". Returns an output Event handle and an [[#IAsyncResult]].
No input/output.


==== GetActivatedRightsUsers ====
=== IReadOnlyApplicationRecordInterface ===
Takes an input u64 "nn::ns::RightsEnvironmentHandle". Returns a bool, an u32 and a type-0x6 output buffer containing an array of [[Account_services#Uid|Uid]].
This is "nn::ns::detail::IReadOnlyApplicationRecordInterface".


==== GetApplicationRightsStatus ====
This was added with [5.0.0+].
Takes an input "nn::ns::RightsEnvironmentHandle". Returns 2 bools "nn::ns::ApplicationRightsStatus" and "nn::ns::ApplicationLicenseType".
 
==== GetRunningApplicationStatus ====
Takes an input u64 "nn::ns::RightsEnvironmentHandle". Returns an u32 "nn::ns::RunningApplicationStatus".
 
==== RequestContentsAuthorizationToken ====
Takes a total of 0x50-bytes of input, a type-0x5 input buffer. Returns an [[#IAsyncData_2|IAsyncData]] and an output handle.
 
==== IAsyncData ====
This is "nn::ns::detail::IAsyncData".
 
This was added with [12.0.0+].


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Cmd || Name
! Cmd || Name || Notes
|-
|-
| 0 || GetSize
| 0 || HasApplicationRecord || Same as [[#IApplicationManagerInterface]] cmd 910
|-
|-
| 1 || Get
| 1 || [10.0.0+] NotifyApplicationFailure ||
|-
|-
| 2 || Cancel
| 2 || [10.0.0+] IsDataCorruptedResult ||
|-
|-
| 3 || GetErrorContext
| 3 || [20.0.0+] ||
|}
|}


=== IECommerceInterface===
=== IReadOnlyApplicationControlDataInterface ===
This is "nn::ns::detail::IECommerceInterface".
This is "nn::ns::detail::IReadOnlyApplicationControlDataInterface".


This was added with [4.0.0+].
This was added with [5.1.0+].


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Cmd || Name
! Cmd || Name || Notes
|-
| 0 || [[#GetApplicationControlData]] || Same as [[#IApplicationManagerInterface]] cmd 400
|-
| 1 || [[#GetApplicationDesiredLanguage]] || Same as [[#IApplicationManagerInterface]] cmd 55
|-
| 2 || ConvertApplicationLanguageToLanguageCode || Same as [[#IApplicationManagerInterface]] cmd 59
|-
| 3 || [[#ConvertLanguageCodeToApplicationLanguage]] || Same as [[#IApplicationManagerInterface]] cmd 60
|-
| 4 || [9.0.0+] SelectApplicationDesiredLanguage ||
|-
| 5 || [19.0.0+] ||
|-
| 6 || [19.0.0+] ||
|-
| 7 || [20.0.0+] ||
|-
| 8 || [20.0.0+] ||
|-
| 9 || [20.0.0+] ||
|-
|-
| 0 || [[#RequestLinkDevice]]
| 10 || [20.0.0+] ||
|-
|-
| 1 || [6.0.0+] [[#RequestCleanupAllPreInstalledApplications]]
| 11 || [20.0.0+] ||
|-
|-
| 2 || [6.0.0+] [[#RequestCleanupPreInstalledApplication]]
| 12 || [20.0.0+] ||
|-
|-
| 3 || [6.0.0+] [[#RequestSyncRights]]
| 13 || [20.0.0+] ||
|-
|-
| 4 || [6.0.0+] [[#RequestUnlinkDevice]]
| 14 || [20.0.0+] ||
|-
|-
| 5 || [6.1.0+] [[#RequestRevokeAllELicense]]
| 15 || [20.0.0+] ||
|-
|-
| 6 || [9.0.0+] [[#RequestSyncRightsBasedOnAssignedELicenses]]
| 16 || [20.0.0+] ||
|-
|-
| 7 || [14.0.0+] RequestOnlineSubscriptionFreeTrialAvailability
| 17 || [20.1.0+] ||
|}
|}


==== RequestLinkDevice ====
=== IDynamicRightsInterface ===
Takes an input [[Account_services#Uid|Uid]], returns an output Event handle and an [[#IAsyncResult]].
This is "nn::ns::detail::IDynamicRightsInterface".


See [[#RequestApplicationUpdateInfo]] regarding nifm.
This was added with [6.0.0+].


==== RequestCleanupAllPreInstalledApplications ====
{| class="wikitable" border="1"
No input, returns an output Event handle and an [[#IAsyncResult]].
 
==== RequestCleanupPreInstalledApplication ====
Takes an input [[NCM_services#ApplicationId|ApplicationId]], returns an output Event handle and an [[#IAsyncResult]].
 
==== RequestSyncRights ====
No input, returns an output Event handle and an [[#IAsyncResult]].
 
==== RequestUnlinkDevice ====
Takes an input [[Account_services#Uid|Uid]], returns an output Event handle and an [[#IAsyncResult]].
 
See [[#RequestApplicationUpdateInfo]] regarding nifm.
 
==== RequestRevokeAllELicense ====
Takes an input [[Account_services#Uid|Uid]], returns an output Event handle and an [[#IAsyncResult]].
 
==== RequestSyncRightsBasedOnAssignedELicenses ====
No input, returns an output Event handle and an [[#IAsyncResult]].
 
=== IFactoryResetInterface ===
This is "nn::ns::detail::IFactoryResetInterface".
 
{| class="wikitable" border="1"
|-
|-
! Cmd || Name
! Cmd || Name
|-
|-
| 100 || [[#ResetToFactorySettings]]
| 0 || [[#RequestApplicationRightsOnServer]]
|-
| 1 || [[#RequestAssignRights]]
|-
|-
| 101 || [[#ResetToFactorySettingsWithoutUserSaveData]]
| 4 || [[#DeprecatedRequestAssignRightsToResume]]
|-
|-
| 102 || [[#ResetToFactorySettingsForRefurbishment]]
| 5 || [[#VerifyActivatedRightsOwners]]
|-
|-
| 103 || [9.1.0+] [[#ResetToFactorySettingsWithPlatformRegion]]
| 6 || [[#DeprecatedGetApplicationRightsStatus]]
|-
|-
| 104 || [9.1.0+] [[#ResetToFactorySettingsWithPlatformRegionAuthentication]]
| 7 || [[#RequestPrefetchForDynamicRights]]
|-
|-
| 105 || [10.0.0+] [[#RequestResetToFactorySettingsSecurely]]
| 8 || [[#GetDynamicRightsState]]
|-
|-
| 106 || [10.0.0+] [[#RequestResetToFactorySettingsWithPlatformRegionAuthenticationSecurely]]
| 9 || [7.0.0+] [[#RequestApplicationRightsOnServerToResume]]
|}
 
==== ResetToFactorySettings ====
No input/output.
 
As of [9.1.0] this is the only [[#IFactoryResetInterface]] cmd used by [[qlaunch]].
 
==== ResetToFactorySettingsWithoutUserSaveData ====
No input/output.
 
==== ResetToFactorySettingsForRefurbishment ====
No input/output.
 
==== ResetToFactorySettingsWithPlatformRegion ====
No input/output.
 
==== ResetToFactorySettingsWithPlatformRegionAuthentication ====
No input/output.
 
==== RequestResetToFactorySettingsSecurely ====
Takes an input u64 tmem_size, a TransferMemory handle, returns an output [[#IAsyncValueAndProgress]] and an Event handle.
 
The TransferMemory uses permissions=0.
 
==== RequestResetToFactorySettingsWithPlatformRegionAuthenticationSecurely ====
Takes an input u32 "nn::ae::PlatformRegion", an u64 tmem_size, a TransferMemory handle, returns an output [[#IAsyncValueAndProgress]] and an Event handle.
 
The TransferMemory uses permissions=0.
 
===== IAsyncValueAndProgress =====
This is "nn::ns::detail::IAsyncValueAndProgress".
 
This was added with [10.0.0+].
 
{| class="wikitable" border="1"
|-
|-
! Cmd || Name
| 10 || [7.0.0+] [[#RequestAssignRightsToResume]]
|-
|-
| 0 || GetSize
| 11 || [7.0.0+] [[#GetActivatedRightsUsers]]
|-
|-
| 1 || Get
| 12 || [8.0.0+] [[#GetApplicationRightsStatus]]
|-
| 13 || [8.0.0+] [[#GetRunningApplicationStatus]]
|-
| 14 || [10.0.0-15.0.1] SelectApplicationLicense
|-
|-
| 2 || Cancel
| 15 || [12.0.0+] [[#RequestContentsAuthorizationToken]]
|-
|-
| 3 || GetErrorContext
| 16 || [13.0.0+] QualifyUser
|-
|-
| 4 || GetProgress
| 17 || [13.0.0+] QualifyUserWithProcessId
|}
 
=== IApplicationResource ===
This is "nn::ns::detail::IApplicationResource".
 
This was added with [9.0.0+].
 
{| class="wikitable" border="1"
|-
|-
! Cmd || Name
| 18 || [13.0.0+] NotifyApplicationRightsCheckStart
|-
|-
| 0 || Attach
| 19 || [13.0.0+] UpdateUserList
|-
|-
| 1 || BoostSystemMemoryResourceLimit
| 20 || [13.0.0+] IsRightsLostUser
|}
 
= ns:vm =
This is "nn::ns::detail::IVulnerabilityManagerInterface".
 
{| class="wikitable" border="1"
|-
|-
! Cmd || Name
| 21 || [13.1.0+] SetRequiredAddOnContentsOnContentsAvailabilityTransition
|-
|-
| 1200 || [3.0.0+] [[#NeedsUpdateVulnerability]]
| 22 || [14.0.0+] GetLimitedApplicationLicense
|-
|-
| 1201 || [4.0.0+] [[#UpdateSafeSystemVersionForDebug]]
| 23 || [14.0.0+] GetLimitedApplicationLicenseUpgradableEvent
|-
|-
| 1202 || [4.0.0+] [[#GetSafeSystemVersion]]
| 24 || [14.0.0+] NotifyLimitedApplicationLicenseUpgradableEventForDebug
|}
|-
 
| 25 || [14.0.0+] RequestProceedDynamicRightsState
== NeedsUpdateVulnerability ==
|-
No input, returns an output u8 bool flag.
| 26 || [18.0.0+] HasAccountRestrictedRightsInRunningApplications
|-
| 27 || [20.0.0+]
|-
| 28 || [20.0.0+]
|}
 
==== RequestApplicationRightsOnServer ====
Takes an input [[NCM_services#ApplicationId|ApplicationId]], an [[Account_services#Uid|Uid]] and an u32. Returns an output Event handle and an [[#IAsyncValue]].


Web-applets use this command to check if the system needs an update.
==== RequestAssignRights ====
Takes a type-0x5 input buffer containing an array of "nn::ns::ApplicationRightsOnServer". Returns an output Event handle and an [[#IAsyncResult]].


== UpdateSafeSystemVersionForDebug ==
==== DeprecatedRequestAssignRightsToResume ====
Takes an input [[NCM_services#ApplicationId|ApplicationId]] and an u32 '''version'''.
Takes an input u64 "nn::ns::RightsEnvironmentHandle" and an [[Account_services#Uid|Uid]]. Returns an output Event handle and an [[#IAsyncResult]].


This command is not available for retail units. On a debug unit, if the [[System_Settings|system setting]] <code>vulnerability!enable_debug</code> is set, this mounts the system savegame [[Flash_Filesystem#System_Savegames|0x8000000000000049]] as "ns_ssversion:/", opens the file "ns_ssversion:/entry" and writes the supplied [[NCM_services#ApplicationId|ApplicationId]] and '''version''' in it.
==== VerifyActivatedRightsOwners ====
Takes an input u64 "nn::ns::RightsEnvironmentHandle". No output.


Finally, it calls [[NCM_services#ncm|OpenContentMetaDatabase]] with [[NCM_services#StorageId|StorageId]] 3, then calls [[NCM_services#IContentMetaDatabase|GetLatestContentMetaKey]] with the supplied [[NCM_services#ApplicationId|ApplicationId]] and compares the version field from the returned [[CNMT#Content_Meta_Records|Content Meta Record]] with the supplied '''version'''.
==== DeprecatedGetApplicationRightsStatus ====
Takes an input u64 "nn::ns::RightsEnvironmentHandle". Returns a bool "nn::ns::ApplicationRightsStatus".


If the supplied '''version''' is higher than the one in NCM's database, the value returned by [[NS_Services#NeedsUpdateVulnerability|NeedsUpdateVulnerability]] is set to "true".
==== RequestPrefetchForDynamicRights ====
Takes an input [[Account_services#Uid|Uid]]. Returns an output Event handle and an [[#IAsyncResult]].


== GetSafeSystemVersion ==
==== GetDynamicRightsState ====
No input, returns an output [[NCM_services#ContentMetaKey|ContentMetaKey]] with the cached contents of "ns_ssversion:/entry" ([[NCM_services#ApplicationId|ApplicationId]], u32 '''version''' and u32 '''policy''' from <code>vulnerability!needs_update_vulnerability_policy</code>).
No input. Returns a bool "nn::ns::DynamicRightsState".


= ns:su =
==== RequestApplicationRightsOnServerToResume ====
This is "nn::ns::detail::ISystemUpdateInterface".
Takes an input u64 "nn::ns::RightsEnvironmentHandle". Returns an output Event handle and an [[#IAsyncValue]].


{| class="wikitable" border="1"
==== RequestAssignRightsToResume ====
|-
Takes an input u64 "nn::ns::RightsEnvironmentHandle". Returns an output Event handle and an [[#IAsyncResult]].
! Cmd || Name
 
|-
==== GetActivatedRightsUsers ====
| 0 || [[#GetBackgroundNetworkUpdateState]]
Takes an input u64 "nn::ns::RightsEnvironmentHandle". Returns a bool, an u32 and a type-0x6 output buffer containing an array of [[Account_services#Uid|Uid]].
 
==== GetApplicationRightsStatus ====
Takes an input "nn::ns::RightsEnvironmentHandle". Returns 2 bools "nn::ns::ApplicationRightsStatus" and "nn::ns::ApplicationLicenseType".
 
==== GetRunningApplicationStatus ====
Takes an input u64 "nn::ns::RightsEnvironmentHandle". Returns an u32 "nn::ns::RunningApplicationStatus".
 
==== RequestContentsAuthorizationToken ====
Takes a total of 0x50-bytes of input, a type-0x5 input buffer. Returns an [[#IAsyncData_2|IAsyncData]] and an output handle.
 
==== IAsyncData ====
This is "nn::ns::detail::IAsyncData".
 
This was added with [12.0.0+].
 
{| class="wikitable" border="1"
|-
|-
| 1 || [[#OpenSystemUpdateControl]]
! Cmd || Name
|-
|-
| 2 || [[#NotifyExFatDriverRequired]]
| 0 || GetSize
|-
|-
| 3 || [[#ClearExFatDriverStatusForDebug]]
| 1 || Get
|-
|-
| 4 || [[#RequestBackgroundNetworkUpdate]]
| 2 || Cancel
|-
|-
| 5 || [[#NotifyBackgroundNetworkUpdate]]
| 3 || GetErrorContext
|}
 
=== IECommerceInterface===
This is "nn::ns::detail::IECommerceInterface".
 
This was added with [4.0.0+].
 
{| class="wikitable" border="1"
|-
|-
| 6 || [[#NotifyExFatDriverDownloadedForDebug]]
! Cmd || Name
|-
| 0 || [[#RequestLinkDevice]]
|-
| 1 || [6.0.0+] [[#RequestCleanupAllPreInstalledApplications]]
|-
| 2 || [6.0.0+] [[#RequestCleanupPreInstalledApplication]]
|-
| 3 || [6.0.0+] [[#RequestSyncRights]]
|-
|-
| 9 || [[#GetSystemUpdateNotificationEventForContentDelivery]]
| 4 || [6.0.0+] [[#RequestUnlinkDevice]]
|-
|-
| 10 || [[#NotifySystemUpdateForContentDelivery]]
| 5 || [6.1.0+] [[#RequestRevokeAllELicense]]
|-
|-
| 11 || [3.0.0+] [[#PrepareShutdown]]
| 6 || [9.0.0+] [[#RequestSyncRightsBasedOnAssignedELicenses]]
|-
|-
| 12 || [3.0.0-3.0.2]
| 7 || [14.0.0+] RequestOnlineSubscriptionFreeTrialAvailability
|-
|-
| 13 || [3.0.0-3.0.2]
| 8 || [20.0.0+]
|-
|-
| 14 || [3.0.0-3.0.2]
| 9 || [20.0.0+]
|-
|-
| 15 || [3.0.0-3.0.2]
| 10 || [20.0.0+]
|-
|-
| 16 || [4.0.0+] [[#DestroySystemUpdateTask]]
| 11 || [20.0.0+]
|-
|-
| 17 || [4.0.0+] [[#RequestSendSystemUpdate]]
| 12 || [20.0.0+]
|-
|-
| 18 || [4.0.0+] [[#GetSendSystemUpdateProgress]]
| 13 || [20.0.0+]
|}
|}


== GetBackgroundNetworkUpdateState ==
==== RequestLinkDevice ====
No input, returns an output [[#BackgroundNetworkUpdateState]].
Takes an input [[Account_services#Uid|Uid]], returns an output Event handle and an [[#IAsyncResult]].


This is similar to [[#HasDownloaded]], see [[#BackgroundNetworkUpdateState]].
See [[#RequestApplicationUpdateInfo]] regarding nifm.


== OpenSystemUpdateControl ==
==== RequestCleanupAllPreInstalledApplications ====
No input, returns an [[#ISystemUpdateControl]].
No input, returns an output Event handle and an [[#IAsyncResult]].


== NotifyExFatDriverRequired ==
==== RequestCleanupPreInstalledApplication ====
No input/output.
Takes an input [[NCM_services#ApplicationId|ApplicationId]], returns an output Event handle and an [[#IAsyncResult]].


Only usable when an [[#ISystemUpdateControl]] isn't open.
==== RequestSyncRights ====
No input, returns an output Event handle and an [[#IAsyncResult]].


This uses [[NIM_services|nim]] ListSystemUpdateTask, then when a task is returned uses it with DestroySystemUpdateTask.
==== RequestUnlinkDevice ====
Takes an input [[Account_services#Uid|Uid]], returns an output Event handle and an [[#IAsyncResult]].


Then this runs ExFat handling, updates state, and sets the same state flag as [[#RequestBackgroundNetworkUpdate]].
See [[#RequestApplicationUpdateInfo]] regarding nifm.


== ClearExFatDriverStatusForDebug ==
==== RequestRevokeAllELicense ====
No input/output.
Takes an input [[Account_services#Uid|Uid]], returns an output Event handle and an [[#IAsyncResult]].


== RequestBackgroundNetworkUpdate ==
==== RequestSyncRightsBasedOnAssignedELicenses ====
No input/output.
No input, returns an output Event handle and an [[#IAsyncResult]].


Only usable when an [[#ISystemUpdateControl]] isn't open.
=== IFactoryResetInterface ===
This is "nn::ns::detail::IFactoryResetInterface".


This sets a state flag to value 1.
{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 100 || [[#ResetToFactorySettings]]
|-
| 101 || [[#ResetToFactorySettingsWithoutUserSaveData]]
|-
| 102 || [[#ResetToFactorySettingsForRefurbishment]]
|-
| 103 || [9.1.0+] [[#ResetToFactorySettingsWithPlatformRegion]]
|-
| 104 || [9.1.0+] [[#ResetToFactorySettingsWithPlatformRegionAuthentication]]
|-
| 105 || [10.0.0+] [[#RequestResetToFactorySettingsSecurely]]
|-
| 106 || [10.0.0+] [[#RequestResetToFactorySettingsWithPlatformRegionAuthenticationSecurely]]
|-
| 107 || [20.0.0+]
|-
| 108 || [20.0.0+]
|}


== NotifyBackgroundNetworkUpdate ==
==== ResetToFactorySettings ====
Takes an input [[NCM_services#ContentMetaKey|ContentMetaKey]], no output.
No input/output.


This checks whether a sysupdate is needed with the input ContentMetaKey using [[NCM_services|NCM]] commands, if not this will just return 0. Otherwise, this will then run code which is identical to [[#RequestBackgroundNetworkUpdate]].
As of [9.1.0] this is the only [[#IFactoryResetInterface]] cmd used by [[qlaunch]].


== NotifyExFatDriverDownloadedForDebug ==
==== ResetToFactorySettingsWithoutUserSaveData ====
No input/output.
No input/output.


== GetSystemUpdateNotificationEventForContentDelivery ==
==== ResetToFactorySettingsForRefurbishment ====
No input, returns an output Event handle with EventClearMode=0.
No input/output.


== NotifySystemUpdateForContentDelivery ==
==== ResetToFactorySettingsWithPlatformRegion ====
No input/output.
No input/output.


Signals the Event returned by [[#GetSystemUpdateNotificationEventForContentDelivery]].
==== ResetToFactorySettingsWithPlatformRegionAuthentication ====
 
== PrepareShutdown ==
No input/output.
No input/output.


This is used by [[AM_services|AM]].
==== RequestResetToFactorySettingsSecurely ====
Takes an input u64 tmem_size, a TransferMemory handle, returns an output [[#IAsyncValueAndProgress]] and an Event handle.


Just returns 0 when an [[#ISystemUpdateControl]] is open.  
The TransferMemory uses permissions=0.


This does various cleanup / uses various service-cmds etc for shutdown preparation.
==== RequestResetToFactorySettingsWithPlatformRegionAuthenticationSecurely ====
Takes an input u32 "nn::ae::PlatformRegion", an u64 tmem_size, a TransferMemory handle, returns an output [[#IAsyncValueAndProgress]] and an Event handle.


== DestroySystemUpdateTask ==
The TransferMemory uses permissions=0.
No input/output.


Only usable when an [[#ISystemUpdateControl]] isn't open.
===== IAsyncValueAndProgress =====
This is "nn::ns::detail::IAsyncValueAndProgress".


This uses [[NIM_services|nim]] ListSystemUpdateTask, then when a task is returned uses it with DestroySystemUpdateTask.
This was added with [10.0.0+].


== RequestSendSystemUpdate ==
{| class="wikitable" border="1"
Takes a type-0x15 input buffer containing a [[#SystemDeliveryInfo]], an u16 port, an u32 Ipv4Address, returns an output Event handle and an [[#IAsyncResult]].
|-
 
! Cmd || Name
[[qlaunch]] uses value 55556 for the port. IP is normally a local-WLAN address, however this can be any address. port/addr are little-endian.
|-
 
| 0 || GetSize
[[NIM_services|NIM]] will use the input addr/port with [[Sockets_services|bind()]]. During [[Sockets_services|accept()]] handling the addr from there must match the input addr. Hence, addr must be the client addr. [[NIM_services|NIM]] will also eventually verify that the system is not Internet-connected.
|-
| 1 || Get
|-
| 2 || Cancel
|-
| 3 || GetErrorContext
|-
| 4 || GetProgress
|}


This validates the [[#SystemDeliveryInfo]] and generates a [[NCM_services#ContentMetaKey|ContentMetaKey]] from that, and creates the [[#IAsyncResult]] + the async thread which handles the [[#IAsyncResult]] operation. Then the thread does:
=== IApplicationResource ===
* Calls a func which does:
This is "nn::ns::detail::IApplicationResource".
** Uses [[NIM_services|nim]] cmd76, returning the Result on failure.
** Uses [[NIM_services|nim]] cmd77, returning the Result on failure. Waits for the IAsyncResult operation from this to finish, then uses the Get cmd to get the output Result.
** Handles cleanup and returns.
* Unlike [[#RequestReceiveSystemUpdate]], this doesn't save a SystemPlayReport.


== GetSendSystemUpdateProgress ==
This was added with [9.0.0+].
No input, returns an output [[#SystemUpdateProgress]].


Same as [[#GetReceiveProgress]] except this uses nim cmd81 and cmd78.
{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || Attach
|-
| 1 || BoostSystemMemoryResourceLimit
|}


== ISystemUpdateControl ==
= ns:vm =
This is "nn::ns::detail::ISystemUpdateControl".
This is "nn::ns::detail::IVulnerabilityManagerInterface".


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 2,269: Line 2,451:
! Cmd || Name
! Cmd || Name
|-
|-
| 0 || [[#HasDownloaded]]
| 1200 || [3.0.0+] [[#NeedsUpdateVulnerability]]
|-
|-
| 1 || [[#RequestCheckLatestUpdate]]
| 1201 || [4.0.0+] [[#UpdateSafeSystemVersionForDebug]]
|-
|-
| 2 || [[#RequestDownloadLatestUpdate]]
| 1202 || [4.0.0+] [[#GetSafeSystemVersion]]
|-
|-
| 3 || [[#GetDownloadProgress]]
| 3100 || [18.0.0+]  
|-
|-
| 4 || [[#ApplyDownloadedUpdate]]
| 3101 || [18.0.0+]  
|-
|-
| 5 || [[#RequestPrepareCardUpdate]]
| 3102 || [18.0.0+]
|}
 
== NeedsUpdateVulnerability ==
No input, returns an output u8 bool flag.
 
Web-applets use this command to check if the system needs an update.
 
== UpdateSafeSystemVersionForDebug ==
Takes an input [[NCM_services#ApplicationId|ApplicationId]] and an u32 '''version'''.
 
This command is not available for retail units. On a debug unit, if the [[System_Settings|system setting]] <code>vulnerability!enable_debug</code> is set, this mounts the system savegame [[Flash_Filesystem#System_Savegames|0x8000000000000049]] as "ns_ssversion:/", opens the file "ns_ssversion:/entry" and writes the supplied [[NCM_services#ApplicationId|ApplicationId]] and '''version''' in it.
 
Finally, it calls [[NCM_services#ncm|OpenContentMetaDatabase]] with [[NCM_services#StorageId|StorageId]] 3, then calls [[NCM_services#IContentMetaDatabase|GetLatestContentMetaKey]] with the supplied [[NCM_services#ApplicationId|ApplicationId]] and compares the version field from the returned [[CNMT#Content_Meta_Records|Content Meta Record]] with the supplied '''version'''.
 
If the supplied '''version''' is higher than the one in NCM's database, the value returned by [[NS_Services#NeedsUpdateVulnerability|NeedsUpdateVulnerability]] is set to "true".
 
== GetSafeSystemVersion ==
No input, returns an output [[NCM_services#ContentMetaKey|ContentMetaKey]] with the cached contents of "ns_ssversion:/entry" ([[NCM_services#ApplicationId|ApplicationId]], u32 '''version''' and u32 '''policy''' from <code>vulnerability!needs_update_vulnerability_policy</code>).
 
= ns:su =
This is "nn::ns::detail::ISystemUpdateInterface".
 
{| class="wikitable" border="1"
|-
|-
| 6 || [[#GetPrepareCardUpdateProgress]]
! Cmd || Name
|-
|-
| 7 || [[#HasPreparedCardUpdate]]
| 0 || [[#GetBackgroundNetworkUpdateState]]
|-
|-
| 8 || [[#ApplyCardUpdate]]
| 1 || [[#OpenSystemUpdateControl]]
|-
|-
| 9 || [[#GetDownloadedEulaDataSize]]
| 2 || [[#NotifyExFatDriverRequired]]
|-
|-
| 10 || [[#GetDownloadedEulaData]]
| 3 || [[#ClearExFatDriverStatusForDebug]]
|-
|-
| 11 || [[#SetupCardUpdate]]
| 4 || [[#RequestBackgroundNetworkUpdate]]
|-
|-
| 12 || [[#GetPreparedCardUpdateEulaDataSize]]
| 5 || [[#NotifyBackgroundNetworkUpdate]]
|-
| 6 || [[#NotifyExFatDriverDownloadedForDebug]]
|-
|-
| 13 || [[#GetPreparedCardUpdateEulaData]]
| 9 || [[#GetSystemUpdateNotificationEventForContentDelivery]]
|-
|-
| 14 || [4.0.0+] [[#SetupCardUpdateViaSystemUpdater]]
| 10 || [[#NotifySystemUpdateForContentDelivery]]
|-
|-
| 15 || [4.0.0+] [[#HasReceived]]
| 11 || [3.0.0+] [[#PrepareShutdown]]
|-
|-
| 16 || [4.0.0+] [[#RequestReceiveSystemUpdate]]
| 12 || [3.0.0-3.0.2]
|-
|-
| 17 || [4.0.0+] [[#GetReceiveProgress]]
| 13 || [3.0.0-3.0.2]
|-
|-
| 18 || [4.0.0+] [[#ApplyReceivedUpdate]]
| 14 || [3.0.0-3.0.2]
|-
|-
| 19 || [4.0.0+] [[#GetReceivedEulaDataSize]]
| 15 || [3.0.0-3.0.2]
|-
|-
| 20 || [4.0.0+] [[#GetReceivedEulaData]]
| 16 || [4.0.0+] [[#DestroySystemUpdateTask]]
|-
|-
| 21 || [4.0.0+] [[#SetupToReceiveSystemUpdate]]
| 17 || [4.0.0+] [[#RequestSendSystemUpdate]]
|-
|-
| 22 || [6.0.0+] [[#RequestCheckLatestUpdateIncludesRebootlessUpdate]]
| 18 || [4.0.0+] [[#GetSendSystemUpdateProgress]]
|}
|}


Only 1 ISystemUpdateControl can be open at a time.
== GetBackgroundNetworkUpdateState ==
No input, returns an output [[#BackgroundNetworkUpdateState]].


All Card cmds except SetupCardUpdate* require [[#SetupCardUpdate]]/[[#SetupCardUpdateViaSystemUpdater]] to be used previously. [[#GetPreparedCardUpdateEulaDataSize]]/[[#GetPreparedCardUpdateEulaData]] checks a different state flag.
This is similar to [[#HasDownloaded]], see [[#BackgroundNetworkUpdateState]].


=== HasDownloaded ===
== OpenSystemUpdateControl ==
No input, returns an output u8 bool flag.
No input, returns an [[#ISystemUpdateControl]].


Gets whether a network sysupdate was downloaded, with install pending.
== NotifyExFatDriverRequired ==
No input/output.


Uses [[NIM_services|nim]] ListSystemUpdateTask and [[NIM_services|nim]] GetSystemUpdateTaskInfo. When ListSystemUpdateTask successfully returns a task and GetSystemUpdateTaskInfo is successful, the output flag is set to: <code>*((u8*)(taskinfo+0) == 0x3</code>. Otherwise, flag=0.
Only usable when an [[#ISystemUpdateControl]] isn't open.


This always returns 0, however this will assert if GetSystemUpdateTaskInfo fails with ret!=0x3C89.
This uses [[NIM_services|nim]] ListSystemUpdateTask, then when a task is returned uses it with DestroySystemUpdateTask.


=== RequestCheckLatestUpdate ===
Then this runs ExFat handling, updates state, and sets the same state flag as [[#RequestBackgroundNetworkUpdate]].
No input, returns an output Event handle and an [[#IAsyncValue]].
 
== ClearExFatDriverStatusForDebug ==
No input/output.
 
== RequestBackgroundNetworkUpdate ==
No input/output.
 
Only usable when an [[#ISystemUpdateControl]] isn't open.
 
This sets a state flag to value 1.


The data that can be read from the [[#IAsyncValue]] is [[#LatestSystemUpdate]].
== NotifyBackgroundNetworkUpdate ==
Takes an input [[NCM_services#ContentMetaKey|ContentMetaKey]], no output.


=== RequestDownloadLatestUpdate ===
This checks whether a sysupdate is needed with the input ContentMetaKey using [[NCM_services|NCM]] commands, if not this will just return 0. Otherwise, this will then run code which is identical to [[#RequestBackgroundNetworkUpdate]].
No input, returns an output Event handle and an [[#IAsyncResult]].


=== GetDownloadProgress ===
== NotifyExFatDriverDownloadedForDebug ==
No input, returns an output [[#SystemUpdateProgress]].
No input/output.


Similar to [[#HasDownloaded]] except instead of a flag, this returns the 0x10-bytes from taskinfo+8. The output struct is cleared when the task(info) isn't available.
== GetSystemUpdateNotificationEventForContentDelivery ==
No input, returns an output Event handle with EventClearMode=0.


=== ApplyDownloadedUpdate ===
== NotifySystemUpdateForContentDelivery ==
No input/output.
No input/output.


Runs code similar to [[#HasDownloaded]], throwing an error if a network sysupdate isn't ready for install. Then the sysupdate is installed:
Signals the Event returned by [[#GetSystemUpdateNotificationEventForContentDelivery]].
 
== PrepareShutdown ==
No input/output.


* Uses ListSystemUpdateTask again, then [[NIM_services|nim]] IsExFatDriverIncluded. Runs ExFat handling when the output flag is set.
This is used by [[AM_services|AM]].
* On newer system-versions, this uses [[NIM_services|nim]] GetSystemUpdateTaskInfo then on success uses data from there to save a SystemPlayReport when the cached [[System_Settings|system-setting]] "systemreport!enabled" is set.
** The EventId is "systemupdate_dl_throughput" with ApplicationId 0100000000001018.
** The following fields are added to the report, see [[NIM_services#SystemUpdateTaskInfo|nim SystemUpdateTaskInfo]]: "ContentMetaId", "Version", "DownloadSize", and "ThroughputKBps".
* On newer system-versions, this saves another SystemPlayReport when a state flag is set (same flag mentioned above).
** The EventId is "systemupdate_pass" with ApplicationId 0100000000001021.
** This report has the following fields:
*** "Type"
*** "SourceSystemUpdateMetaId"
*** "SourceSystemUpdateMetaVersion"
*** "SourceExFatStatus"
*** "DestinationSystemUpdateMetaId"
*** "DestinationSystemUpdateMetaVersion"
*** "DestinationExFatStatus"
*** "Rebootless"
* Since FIRM will be installed later, the two flags in [[Flash_Filesystem#System_Update_Control]] are set to 1.
* Uses [[NIM_services|nim]] CommitSystemUpdateTask and [[NIM_services|nim]] DestroySystemUpdateTask.
* Installs FIRM. After installing each FIRM, the associated flag in [[Flash_Filesystem#System_Update_Control]] is set to 0.
* On newer system versions when an input flag is set, this uses [[Filesystem_services|NotifySystemDataUpdateEvent]], however this doesn't happen with ApplyDownloadedUpdate since that input flag is 0.


=== RequestPrepareCardUpdate ===
Just returns 0 when an [[#ISystemUpdateControl]] is open.  
No input, returns an output Event handle and an [[#IAsyncResult]].


=== GetPrepareCardUpdateProgress ===
This does various cleanup / uses various service-cmds etc for shutdown preparation.
No input, returns an output [[#SystemUpdateProgress]].


=== HasPreparedCardUpdate ===
== DestroySystemUpdateTask ==
No input, returns an output u8 bool flag.
 
=== ApplyCardUpdate ===
No input/output.
No input/output.


=== GetDownloadedEulaDataSize ===
Only usable when an [[#ISystemUpdateControl]] isn't open.
Takes a type-0x15 input buffer [[#EulaDataPath]], returns an output u64 '''filesize'''.


Runs code similar to [[#HasDownloaded]], throwing an error if a network sysupdate isn't ready for install.
This uses [[NIM_services|nim]] ListSystemUpdateTask, then when a task is returned uses it with DestroySystemUpdateTask.


Uses ListSystemUpdateTask again. Then [[NIM_services|nim]] GetDownloadedSystemDataPath, with the output ContentPath being used to mount the EULA title with FS.
== RequestSendSystemUpdate ==
Takes a type-0x15 input buffer containing a [[#SystemDeliveryInfo]], an u16 port, an u32 Ipv4Address, returns an output Event handle and an [[#IAsyncResult]].


Then "<mountname>:/<[[#EulaDataPath]]>" is opened, gets the '''filesize''', then runs cleanup.
[[qlaunch]] uses value 55556 for the port. IP is normally a local-WLAN address, however this can be any address. port/addr are little-endian.


=== GetDownloadedEulaData ===
[[NIM_services|NIM]] will use the input addr/port with [[Sockets_services|bind()]]. During [[Sockets_services|accept()]] handling the addr from there must match the input addr. Hence, addr must be the client addr. [[NIM_services|NIM]] will also eventually verify that the system is not Internet-connected.
Takes a type-0x15 input buffer [[#EulaDataPath]] and a type-0x6 output buffer, returns an output u64 '''filesize'''.


Similar to [[#GetDownloadedEulaDataSize]] except this reads the file instead, using the specified output buffer with size=filesize. This will throw an error if the filesize is larger than the buffer size.
This validates the [[#SystemDeliveryInfo]] and generates a [[NCM_services#ContentMetaKey|ContentMetaKey]] from that, and creates the [[#IAsyncResult]] + the async thread which handles the [[#IAsyncResult]] operation. Then the thread does:
 
* Calls a func which does:
=== SetupCardUpdate ===
** Uses [[NIM_services|nim]] cmd76, returning the Result on failure.
Takes an input u64 size and a TransferMemory handle, no output.
** Uses [[NIM_services|nim]] cmd77, returning the Result on failure. Waits for the IAsyncResult operation from this to finish, then uses the Get cmd to get the output Result.
** Handles cleanup and returns.
* Unlike [[#RequestReceiveSystemUpdate]], this doesn't save a SystemPlayReport.


Official sw creates the TransferMemory with an user-specified buffer, with permissions=None.
== GetSendSystemUpdateProgress ==
No input, returns an output [[#SystemUpdateProgress]].


[[qlaunch]] uses size 0x100000 for the TransferMemory buffer.
Same as [[#GetReceiveProgress]] except this uses nim cmd81 and cmd78.


=== GetPreparedCardUpdateEulaDataSize ===
== ISystemUpdateControl ==
Takes a type-0x15 input buffer [[#EulaDataPath]], returns an output u64 '''filesize'''.
This is "nn::ns::detail::ISystemUpdateControl".


This is similar to [[#GetDownloadedEulaDataSize]].
{| class="wikitable" border="1"
 
|-
=== GetPreparedCardUpdateEulaData ===
! Cmd || Name
Takes a type-0x15 input buffer [[#EulaDataPath]] and a type-0x6 output buffer, returns an output u64 '''filesize'''.
|-
 
| 0 || [[#HasDownloaded]]
This is similar to [[#GetDownloadedEulaData]].
|-
 
| 1 || [[#RequestCheckLatestUpdate]]
=== SetupCardUpdateViaSystemUpdater ===
|-
Takes an input u64 size and a TransferMemory handle, no output.
| 2 || [[#RequestDownloadLatestUpdate]]
 
|-
The permissions for the TransferMemory is None.
| 3 || [[#GetDownloadProgress]]
 
|-
Same as [[#SetupCardUpdate]], except this doesn't have the code for [[Filesystem_services|GetGameCardHandle/GetGameCardUpdatePartitionInfo]], and uses [[Filesystem_services|OpenRegisteredUpdatePartition]] instead of [[Filesystem_services|OpenGameCardFileSystem]]. This uses the same is_initialized bool state flag.
| 4 || [[#ApplyDownloadedUpdate]]
|-
| 5 || [[#RequestPrepareCardUpdate]]
|-
| 6 || [[#GetPrepareCardUpdateProgress]]
|-
| 7 || [[#HasPreparedCardUpdate]]
|-
| 8 || [[#ApplyCardUpdate]]
|-
| 9 || [[#GetDownloadedEulaDataSize]]
|-
| 10 || [[#GetDownloadedEulaData]]
|-
| 11 || [[#SetupCardUpdate]]
|-
| 12 || [[#GetPreparedCardUpdateEulaDataSize]]
|-
| 13 || [[#GetPreparedCardUpdateEulaData]]
|-
| 14 || [4.0.0+] [[#SetupCardUpdateViaSystemUpdater]]
|-
| 15 || [4.0.0+] [[#HasReceived]]
|-
| 16 || [4.0.0+] [[#RequestReceiveSystemUpdate]]
|-
| 17 || [4.0.0+] [[#GetReceiveProgress]]
|-
| 18 || [4.0.0+] [[#ApplyReceivedUpdate]]
|-
| 19 || [4.0.0+] [[#GetReceivedEulaDataSize]]
|-
| 20 || [4.0.0+] [[#GetReceivedEulaData]]
|-
| 21 || [4.0.0+] [[#SetupToReceiveSystemUpdate]]
|-
| 22 || [6.0.0+] [[#RequestCheckLatestUpdateIncludesRebootlessUpdate]]
|}


=== HasReceived ===
Only 1 ISystemUpdateControl can be open at a time.
No input, returns an output u8 bool.


Same as [[#HasDownloaded]] except this uses [[NIM_services|nim]] cmd71 and cmd73.
All Card cmds except SetupCardUpdate* require [[#SetupCardUpdate]]/[[#SetupCardUpdateViaSystemUpdater]] to be used previously. [[#GetPreparedCardUpdateEulaDataSize]]/[[#GetPreparedCardUpdateEulaData]] checks a different state flag.


=== RequestReceiveSystemUpdate ===
=== HasDownloaded ===
Takes a type-0x15 input buffer containing a [[#SystemDeliveryInfo]], an u16 port, an u32 Ipv4Address, returns an output Event handle and an [[#IAsyncResult]].
No input, returns an output u8 bool flag.


[[qlaunch]] uses the same value for the port as [[#RequestSendSystemUpdate]] (see [[#RequestSendSystemUpdate]] for addr as well).
Gets whether a network sysupdate was downloaded, with install pending.


[[NIM_services|NIM]] will use the input addr/port with [[Sockets_services|connect()]].
Uses [[NIM_services|nim]] ListSystemUpdateTask and [[NIM_services|nim]] GetSystemUpdateTaskInfo. When ListSystemUpdateTask successfully returns a task and GetSystemUpdateTaskInfo is successful, the output flag is set to: <code>*((u8*)(taskinfo+0) == 0x3</code>. Otherwise, flag=0.


This validates the [[#SystemDeliveryInfo]] and generates a [[NCM_services#ContentMetaKey|ContentMetaKey]] from that, and creates the [[#IAsyncResult]] + the async thread which handles the [[#IAsyncResult]] operation. Then the thread does:
This always returns 0, however this will assert if GetSystemUpdateTaskInfo fails with ret!=0x3C89.


* Calls a func which does:
=== RequestCheckLatestUpdate ===
** Throws an error if [[NIM_services#ListSystemUpdateTask|ListSystemUpdateTask]] returns any task.
No input, returns an output Event handle and an [[#IAsyncValue]].
** Checks whether a sysupdate is actually required using the previously generated [[NCM_services#ContentMetaKey|ContentMetaKey]], throwing an error if not.
** Uses [[NIM_services|nim]] cmd69, returning the Result on failure.
** Uses [[NIM_services|nim]] cmd72, returning the Result on failure. Waits for the IAsyncResult operation from this to finish, then uses the Get cmd to get the output Result.
** Handles cleanup and returns.
* On success, this loads various data which is then used for saving a SystemPlayReport when the cached [[System_Settings|system-setting]] "systemreport!enabled" is set.
** The EventId is "receive_system_update" with ApplicationId <NS ProgramId>.
** This report has the following fields:
*** "SourceSystemUpdateId"
*** "DestinationSystemUpdateId"
*** "SourceSystemUpdateVersion"
*** "DestinationSystemUpdateVersion"
*** "SenderFirmwareVariationId"
*** "ReceiverFirmwareVariationId"
*** "SenderPlatformRegion"
*** "ReceiverPlatformRegion"
*** "SenderHasExFat"
*** "ReceiverHasExFat"
*** "Size"
*** "ThroughputKBps"


=== GetReceiveProgress ===
The data that can be read from the [[#IAsyncValue]] is [[#LatestSystemUpdate]].
No input, returns an output [[#SystemUpdateProgress]].


Same as [[#GetDownloadProgress]] except this uses [[NIM_services|nim]] cmd71 and cmd73.
=== RequestDownloadLatestUpdate ===
No input, returns an output Event handle and an [[#IAsyncResult]].


=== ApplyReceivedUpdate ===
=== GetDownloadProgress ===
No input/output.
No input, returns an output [[#SystemUpdateProgress]].


=== GetReceivedEulaDataSize ===
Similar to [[#HasDownloaded]] except instead of a flag, this returns the 0x10-bytes from taskinfo+8. The output struct is cleared when the task(info) isn't available.
Takes a type-0x15 input buffer [[#EulaDataPath]], returns an output u64 '''filesize'''.


This is similar to [[#GetDownloadedEulaDataSize]].
=== ApplyDownloadedUpdate ===
No input/output.


=== GetReceivedEulaData ===
Runs code similar to [[#HasDownloaded]], throwing an error if a network sysupdate isn't ready for install. Then the sysupdate is installed:
Takes a type-0x15 input buffer [[#EulaDataPath]] and a type-0x6 output buffer, returns an output u64 '''filesize'''.


This is similar to [[#GetDownloadedEulaData]].
* Uses ListSystemUpdateTask again, then [[NIM_services|nim]] IsExFatDriverIncluded. Runs ExFat handling when the output flag is set.
* On newer system-versions, this uses [[NIM_services|nim]] GetSystemUpdateTaskInfo then on success uses data from there to save a SystemPlayReport when the cached [[System_Settings|system-setting]] "systemreport!enabled" is set.
** The EventId is "systemupdate_dl_throughput" with ApplicationId 0100000000001018.
** The following fields are added to the report, see [[NIM_services#SystemUpdateTaskInfo|nim SystemUpdateTaskInfo]]: "ContentMetaId", "Version", "DownloadSize", and "ThroughputKBps".
* On newer system-versions, this saves another SystemPlayReport when a state flag is set (same flag mentioned above).
** The EventId is "systemupdate_pass" with ApplicationId 0100000000001021.
** This report has the following fields:
*** "Type"
*** "SourceSystemUpdateMetaId"
*** "SourceSystemUpdateMetaVersion"
*** "SourceExFatStatus"
*** "DestinationSystemUpdateMetaId"
*** "DestinationSystemUpdateMetaVersion"
*** "DestinationExFatStatus"
*** "Rebootless"
* Since FIRM will be installed later, the two flags in [[Flash_Filesystem#System_Update_Control]] are set to 1.
* Uses [[NIM_services|nim]] CommitSystemUpdateTask and [[NIM_services|nim]] DestroySystemUpdateTask.
* Installs FIRM. After installing each FIRM, the associated flag in [[Flash_Filesystem#System_Update_Control]] is set to 0.
* On newer system versions when an input flag is set, this uses [[Filesystem_services|NotifySystemDataUpdateEvent]], however this doesn't happen with ApplyDownloadedUpdate since that input flag is 0.


=== SetupToReceiveSystemUpdate ===
=== RequestPrepareCardUpdate ===
No input/output.
No input, returns an output Event handle and an [[#IAsyncResult]].


This just uses [[NIM_services|nim]] ListSystemUpdateTask, then when a task is returned uses it with DestroySystemUpdateTask.
=== GetPrepareCardUpdateProgress ===
No input, returns an output [[#SystemUpdateProgress]].
 
=== HasPreparedCardUpdate ===
No input, returns an output u8 bool flag.


[[qlaunch]] uses this before [[#RequestReceiveSystemUpdate]].
=== ApplyCardUpdate ===
No input/output.


=== RequestCheckLatestUpdateIncludesRebootlessUpdate ===
=== GetDownloadedEulaDataSize ===
No input, returns an output Event handle and an [[#IAsyncValue]].
Takes a type-0x15 input buffer [[#EulaDataPath]], returns an output u64 '''filesize'''.


= IAsyncValue =
Runs code similar to [[#HasDownloaded]], throwing an error if a network sysupdate isn't ready for install.
This is "nn::ns::detail::IAsyncValue".


{| class="wikitable" border="1"
Uses ListSystemUpdateTask again. Then [[NIM_services|nim]] GetDownloadedSystemDataPath, with the output ContentPath being used to mount the EULA title with FS.
|-
! Cmd || Name
|-
| 0 || GetSize
|-
| 1 || Get
|-
| 2 || Cancel
|-
| 3 || [4.0.0+] GetErrorContext
|}


Official sw creates a container object for this using the output from the service commands, which contains the IAsyncValue object, and the Event with EventClearMode=0.
Then "<mountname>:/<[[#EulaDataPath]]>" is opened, gets the '''filesize''', then runs cleanup.


* GetSize: No input, returns an output u64.
=== GetDownloadedEulaData ===
* Get: Takes a type-0x6 output buffer, no output. Official sw waits on the Event prior to using this cmd.
Takes a type-0x15 input buffer [[#EulaDataPath]] and a type-0x6 output buffer, returns an output u64 '''filesize'''.
* Cancel: No input/output. Used by official sw when closing the object, when the serv-obj is initialized (after using the cmd, official sw will also wait on the Event). This cmd is also used in other official sw funcs.
* GetErrorContext: No input/output, takes a type-0x16 output buffer containing an [[Error_Applet#ErrorContext|ErrorContext]].


= IAsyncResult =
Similar to [[#GetDownloadedEulaDataSize]] except this reads the file instead, using the specified output buffer with size=filesize. This will throw an error if the filesize is larger than the buffer size.
This is "nn::ns::detail::IAsyncResult".


{| class="wikitable" border="1"
=== SetupCardUpdate ===
|-
Takes an input u64 size and a TransferMemory handle, no output.
! Cmd || Name
 
|-
Official sw creates the TransferMemory with an user-specified buffer, with permissions=None.
| 0 || Get
 
|-
[[qlaunch]] uses size 0x100000 for the TransferMemory buffer.
| 1 || Cancel
 
|-
=== GetPreparedCardUpdateEulaDataSize ===
| 2 || [4.0.0+] GetErrorContext
Takes a type-0x15 input buffer [[#EulaDataPath]], returns an output u64 '''filesize'''.
|}


Official sw creates a container object for this using the output from the service commands, which contains the IAsyncResult object, and the Event with EventClearMode=0.
This is similar to [[#GetDownloadedEulaDataSize]].


* Get: No input/output. Official sw waits on the Event prior to using this cmd.
=== GetPreparedCardUpdateEulaData ===
* Cancel: No input/output. Used by official sw when closing the object, when the serv-obj is initialized (after using the cmd, official sw will also wait on the Event). This cmd is also used in other official sw funcs.
Takes a type-0x15 input buffer [[#EulaDataPath]] and a type-0x6 output buffer, returns an output u64 '''filesize'''.
* GetErrorContext: No input/output, takes a type-0x16 output buffer containing an [[Error_Applet#ErrorContext|ErrorContext]].


= ns:dev =
This is similar to [[#GetDownloadedEulaData]].
This is "nn::ns::detail::IDevelopInterface".


[10.0.0+] Some of these cmds were replaced by the [[PGL_services|pgl]] system module.
=== SetupCardUpdateViaSystemUpdater ===
Takes an input u64 size and a TransferMemory handle, no output.


{| class="wikitable" border="1"
The permissions for the TransferMemory is None.
|-
! Cmd || Name
|-
| 0 || [1.0.0-9.2.0] [[#LaunchProgram]]
|-
| 1 || [[#TerminateProcess]]
|-
| 2 || [1.0.0-9.2.0] [[#TerminateProgram]]
|-
| 4 || [1.0.0-9.2.0] [[#GetShellEvent]]
|-
| 5 || [1.0.0-9.2.0] [[#GetShellEventInfo]]
|-
| 6 || [[#TerminateApplication]]
|-
| 7 || [1.0.0-9.2.0] [[#PrepareLaunchProgramFromHost]]
|-
| 8 || [10.0.0+] [[#LaunchApplicationFromHost]] ([1.0.0-9.2.0] [[#LaunchApplicationForDevelop]])
|-
| 9 || [[#LaunchApplicationWithStorageIdForDevelop]]
|-
| 10 || [6.0.0-8.1.0] [[#IsSystemMemoryResourceLimitBoosted]]
|-
| 11 || [6.0.0+] [[#GetRunningApplicationProcessIdForDevelop]]
|-
| 12 || [6.0.0+] [[#SetCurrentApplicationRightsEnvironmentCanBeActiveForDevelop]]
|-
| 13 || [9.0.0+] [[#CreateApplicationResourceForDevelop]]
|-
| 14 || [9.0.0+] [[#IsPreomiaForDevelop]]
|-
| 15 || [10.0.0+] [[#GetApplicationProgramIdFromHost]]
|-
| 16 || [12.0.0+] RefreshCachedDebugValues
|-
| 17 || [12.0.0+] PrepareLaunchApplicationFromHost
|-
| 18 || [12.0.0+] GetLaunchEvent
|-
| 19 || [12.0.0+] GetLaunchResult
|-
| 20 || [14.0.0+] GetProgramId
|}


== LaunchProgram ==
Same as [[#SetupCardUpdate]], except this doesn't have the code for [[Filesystem_services|GetGameCardHandle/GetGameCardUpdatePartitionInfo]], and uses [[Filesystem_services|OpenRegisteredUpdatePartition]] instead of [[Filesystem_services|OpenGameCardFileSystem]]. This uses the same is_initialized bool state flag.
Wrapper for "pm:shell" [[Process_Manager_services#pm:shell|LaunchProcess]].


== TerminateProcess ==
=== HasReceived ===
Wrapper for "pm:shell" [[Process_Manager_services#pm:shell|TerminateProcess]].
No input, returns an output u8 bool.


== TerminateProgram ==
Same as [[#HasDownloaded]] except this uses [[NIM_services|nim]] cmd71 and cmd73.
Wrapper for "pm:shell" [[Process_Manager_services#pm:shell|TerminateProgram]].


== GetShellEvent ==
=== RequestReceiveSystemUpdate ===
Wrapper for "pm:shell" [[Process_Manager_services#pm:shell|GetProcessEventHandle]].
Takes a type-0x15 input buffer containing a [[#SystemDeliveryInfo]], an u16 port, an u32 Ipv4Address, returns an output Event handle and an [[#IAsyncResult]].


== GetShellEventInfo ==
[[qlaunch]] uses the same value for the port as [[#RequestSendSystemUpdate]] (see [[#RequestSendSystemUpdate]] for addr as well).
Wrapper for "pm:shell" [[Process_Manager_services#pm:shell|GetProcessEventInfo]].


== TerminateApplication ==
[[NIM_services|NIM]] will use the input addr/port with [[Sockets_services|connect()]].
Calls "pm:shell" [[Process_Manager_services#pm:shell|GetApplicationProcessIdForShell]] and sends the ProcessId to [[Process_Manager_services#pm:shell|TerminateProcess]].


== PrepareLaunchProgramFromHost ==
This validates the [[#SystemDeliveryInfo]] and generates a [[NCM_services#ContentMetaKey|ContentMetaKey]] from that, and creates the [[#IAsyncResult]] + the async thread which handles the [[#IAsyncResult]] operation. Then the thread does:
Takes a type-0x5 input buffer containing the [[Filesystem_services|ContentPath]], returns an output 0x10-byte struct.


Calls [[NCM_services#IPathResolverForStorage|IPathResolverForStorage]] Set...NcaPath functions.
* Calls a func which does:
** Throws an error if [[NIM_services#ListSystemUpdateTask|ListSystemUpdateTask]] returns any task.
** Checks whether a sysupdate is actually required using the previously generated [[NCM_services#ContentMetaKey|ContentMetaKey]], throwing an error if not.
** Uses [[NIM_services|nim]] cmd69, returning the Result on failure.
** Uses [[NIM_services|nim]] cmd72, returning the Result on failure. Waits for the IAsyncResult operation from this to finish, then uses the Get cmd to get the output Result.
** Handles cleanup and returns.
* On success, this loads various data which is then used for saving a SystemPlayReport when the cached [[System_Settings|system-setting]] "systemreport!enabled" is set.
** The EventId is "receive_system_update" with ApplicationId <NS ProgramId>.
** This report has the following fields:
*** "SourceSystemUpdateId"
*** "DestinationSystemUpdateId"
*** "SourceSystemUpdateVersion"
*** "DestinationSystemUpdateVersion"
*** "SenderFirmwareVariationId"
*** "ReceiverFirmwareVariationId"
*** "SenderPlatformRegion"
*** "ReceiverPlatformRegion"
*** "SenderHasExFat"
*** "ReceiverHasExFat"
*** "Size"
*** "ThroughputKBps"


== LaunchApplicationForDevelop ==
=== GetReceiveProgress ===
Takes an input u32 [[Process_Manager_services#LaunchFlags|LaunchFlags]] and [[NCM_services#ApplicationId|ApplicationId]], returns an output u64 ProcessId.
No input, returns an output [[#SystemUpdateProgress]].


Same as [[#LaunchApplicationWithStorageIdForDevelop]] except the last two params passed to the internal vtable funcptr call are value 0x6, instead of from the command input.
Same as [[#GetDownloadProgress]] except this uses [[NIM_services|nim]] cmd71 and cmd73.


== LaunchApplicationFromHost ==
=== ApplyReceivedUpdate ===
Takes an input u32 [[Process_Manager_services#LaunchFlags|LaunchFlags]] and a type-0x5 input buffer containing the [[Filesystem_services|ContentPath]]. Returns an output u64 ProcessId.
No input/output.


== LaunchApplicationWithStorageIdForDevelop ==
=== GetReceivedEulaDataSize ===
Takes 2 input u8 [[NCM_services#StorageId|StorageIds]], an u32 [[Process_Manager_services#LaunchFlags|LaunchFlags]], and an [[NCM_services#ApplicationId|ApplicationId]]. Returns an output u64 ProcessId.
Takes a type-0x15 input buffer [[#EulaDataPath]], returns an output u64 '''filesize'''.


Launches an application title which is registered with NS.
This is similar to [[#GetDownloadedEulaDataSize]].


== IsSystemMemoryResourceLimitBoosted ==
=== GetReceivedEulaData ===
No input. Returns a bool.
Takes a type-0x15 input buffer [[#EulaDataPath]] and a type-0x6 output buffer, returns an output u64 '''filesize'''.


== GetRunningApplicationProcessIdForDevelop ==
This is similar to [[#GetDownloadedEulaData]].
Returns an output u64 ProcessId.


== SetCurrentApplicationRightsEnvironmentCanBeActiveForDevelop ==
=== SetupToReceiveSystemUpdate ===
Takes an input bool. No output.
No input/output.


== CreateApplicationResourceForDevelop ==
This just uses [[NIM_services|nim]] ListSystemUpdateTask, then when a task is returned uses it with DestroySystemUpdateTask.
Takes an input u32 (1 = Preomia/MicroApplication). Returns an [[#IApplicationResource]].


== IsPreomiaForDevelop ==
[[qlaunch]] uses this before [[#RequestReceiveSystemUpdate]].
Takes an input u64 [[NCM_services#ProgramId|ProgramId]]. Returns a bool.


== GetApplicationProgramIdFromHost ==
=== RequestCheckLatestUpdateIncludesRebootlessUpdate ===
Takes a type-0x5 input buffer containing the [[Filesystem_services|ContentPath]]. Returns an u64 [[NCM_services#ProgramId|ProgramId]].
No input, returns an output Event handle and an [[#IAsyncValue]].


= acc:su =
= IAsyncValue =
This is "nn::account::IAccountServiceForAdministrator".
This is "nn::ns::detail::IAsyncValue".
 
[13.0.0+] This was moved from [[Account_services|account]].
 
This is only available when the output from [[Process_Manager_services|pm:bm]] GetBootMode is Normal/Maintenance.


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Cmd || Name || Notes
! Cmd || Name
|-
|-
| 0 || GetUserCount ||
| 0 || GetSize
|-
|-
| 1 || GetUserExistence ||
| 1 || Get
|-
|-
| 2 || ListAllUsers ||
| 2 || Cancel
|-
|-
| 3 || ListOpenUsers ||
| 3 || [4.0.0+] GetErrorContext
|-
|}
| 4 || GetLastOpenedUser ||
 
Official sw creates a container object for this using the output from the service commands, which contains the IAsyncValue object, and the Event with EventClearMode=0.
 
* GetSize: No input, returns an output u64.
* Get: Takes a type-0x6 output buffer, no output. Official sw waits on the Event prior to using this cmd.
* Cancel: No input/output. Used by official sw when closing the object, when the serv-obj is initialized (after using the cmd, official sw will also wait on the Event). This cmd is also used in other official sw funcs.
* GetErrorContext: No input/output, takes a type-0x16 output buffer containing an [[Error_Applet#ErrorContext|ErrorContext]].
 
= IAsyncResult =
This is "nn::ns::detail::IAsyncResult".
 
{| class="wikitable" border="1"
|-
|-
| 5 || GetProfile || Returns an [[#IProfile]].
! Cmd || Name
|-
|-
| 6 || [3.0.0+] GetProfileDigest ||
| 0 || Get
|-
|-
| 50 || [[#IsUserRegistrationRequestPermitted]] ||
| 1 || Cancel
|-
|-
| 51 || [[#TrySelectUserWithoutInteraction]] ||
| 2 || [4.0.0+] GetErrorContext
|}
 
Official sw creates a container object for this using the output from the service commands, which contains the IAsyncResult object, and the Event with EventClearMode=0.
 
* Get: No input/output. Official sw waits on the Event prior to using this cmd.
* Cancel: No input/output. Used by official sw when closing the object, when the serv-obj is initialized (after using the cmd, official sw will also wait on the Event). This cmd is also used in other official sw funcs.
* GetErrorContext: No input/output, takes a type-0x16 output buffer containing an [[Error_Applet#ErrorContext|ErrorContext]].
 
= ns:dev =
This is "nn::ns::detail::IDevelopInterface".
 
[10.0.0+] Some of these cmds were replaced by the [[PGL_services|pgl]] system module.
 
{| class="wikitable" border="1"
|-
|-
| 60 || [5.0.0-5.1.0] ListOpenContextStoredUsers ||
! Cmd || Name
|-
|-
| 99 || [6.0.0+] DebugActivateOpenContextRetention || No input, returns an [[#ISessionObject]].
| 0 || [1.0.0-9.2.0] [[#LaunchProgram]]
|-
|-
| 100 || GetUserRegistrationNotifier || Returns an [[#INotifier]].
| 1 || [[#TerminateProcess]]
|-
|-
| 101 || GetUserStateChangeNotifier || Returns an [[#INotifier]].
| 2 || [1.0.0-9.2.0] [[#TerminateProgram]]
|-
|-
| 102 || GetBaasAccountManagerForSystemService || Returns an [[#IManagerForSystemService]].
| 4 || [1.0.0-9.2.0] [[#GetShellEvent]]
|-
|-
| 103 || GetBaasUserAvailabilityChangeNotifier || Returns an [[#INotifier]].
| 5 || [1.0.0-9.2.0] [[#GetShellEventInfo]]
|-
|-
| 104 || GetProfileUpdateNotifier || Returns an [[#INotifier]].
| 6 || [[#TerminateApplication]]
|-
|-
| 105 || [4.0.0+] CheckNetworkServiceAvailabilityAsync || Returns an [[#IAsyncContext]].
| 7 || [1.0.0-9.2.0] [[#PrepareLaunchProgramFromHost]]
|-
|-
| 106 || [9.0.0+] GetProfileSyncNotifier ||
| 8 || [10.0.0-17.0.1] [[#LaunchApplicationFromHost]] ([1.0.0-9.2.0] LaunchApplication)
|-
|-
| 110 || StoreSaveDataThumbnail ||
| 9 || [1.0.0-17.0.1] [[#LaunchApplicationWithStorageId]]
|-
|-
| 111 || ClearSaveDataThumbnail ||
| 10 || [6.0.0-8.1.0] [[#IsSystemMemoryResourceLimitBoosted]]
|-
|-
| 112 || LoadSaveDataThumbnail ||
| 11 || [6.0.0+] [[#GetRunningApplicationProcessId]]
|-
|-
| 113 || [5.0.0+] GetSaveDataThumbnailExistence ||
| 12 || [6.0.0+] [[#SetCurrentApplicationRightsEnvironmentCanBeActive]]
|-
| 120 || [10.0.0+] ListOpenUsersInApplication ||
|-
|-
| 130 || [6.0.0+] ActivateOpenContextRetention || Takes a total of 0x8-bytes of input, returns an [[#ISessionObject]].
| 13 || [9.0.0+] [[#CreateApplicationResource]]
|-
|-
| 140 || [6.0.0+] ListQualifiedUsers ||
| 14 || [9.0.0+] [[#IsPreomia]]
|-
|-
| 150 || [10.0.0-10.2.0] AuthenticateApplicationAsync ||
| 15 || [10.0.0-17.0.1] [[#GetApplicationProgramIdFromHost]]
|-
|-
| 151 || [12.0.0+] EnsureSignedDeviceIdentifierCacheForNintendoAccountAsync ||
| 16 || [12.0.0+] RefreshCachedDebugValues
|-
|-
| 152 || [12.0.0+] LoadSignedDeviceIdentifierCacheForNintendoAccount ||
| 17 || [12.0.0+] [[#PrepareLaunchApplicationFromHost]]
|-
|-
| 170 || [13.0.0+] GetNasOp2MembershipStateChangeNotifier ||
| 18 || [12.0.0+] [[#GetLaunchEvent]]
|-
|-
| 190 || [1.0.0-9.2.0] GetUserLastOpenedApplication ||
| 19 || [12.0.0+] [[#GetLaunchResult]]
|-
|-
| 191 || [7.0.0+] UpdateNotificationReceiverInfo ([5.0.0-5.1.0] ActivateOpenContextHolder) ||
| 20 || [14.0.0+] GetProgramId
|-
|-
| 200 || BeginUserRegistration ||
| 21 || [18.0.0+] [[#PrepareLaunchApplication]]
|-
|-
| 201 || CompleteUserRegistration ||
| 22 || [18.0.0+] [[#LaunchApplication]]
|-
|-
| 202 || CancelUserRegistration ||
| 23 || [18.0.0+] [[#GetProgramIdByApplicationLaunchInfo]]
|-
|-
| 203 || DeleteUser ||
| 24 || [18.0.0+] DestroyApplicationLaunchPreparation
|-
|}
| 204 || SetUserPosition ||
 
|-
== LaunchProgram ==
| 205 || GetProfileEditor || Takes an input userID and returns an [[#IProfileEditor]].
Wrapper for "pm:shell" [[Process_Manager_services#pm:shell|LaunchProcess]].
|-
 
| 206 || CompleteUserRegistrationForcibly ||
== TerminateProcess ==
|-
Wrapper for "pm:shell" [[Process_Manager_services#pm:shell|TerminateProcess]].
| 210 || [3.0.0+] CreateFloatingRegistrationRequest || Returns an [[#IFloatingRegistrationRequest]].
 
|-
== TerminateProgram ==
| 211 || [8.0.0+] CreateProcedureToRegisterUserWithNintendoAccount || Takes a total of 0x4-bytes of input and a handle, returns an [[#IOAuthProcedureForUserRegistration]].
Wrapper for "pm:shell" [[Process_Manager_services#pm:shell|TerminateProgram]].
|-
| 212 || [8.0.0+] ResumeProcedureToRegisterUserWithNintendoAccount || Takes a total of 0x14-bytes of input and a handle, returns an [[#IOAuthProcedureForUserRegistration]].
|-
| 230 || AuthenticateServiceAsync || Returns an [[#IAsyncContext]].
|-
| 250 || GetBaasAccountAdministrator || Returns an [[#IAdministrator]].
|-
| 290 || ProxyProcedureForGuestLoginWithNintendoAccount || Returns an [[#IOAuthProcedureForExternalNsa]] (formerly [[#IOAuthProcedureForGuestLogin]] with [1.0.0-2.3.0]).
|-
| 291 || [3.0.0+] ProxyProcedureForFloatingRegistrationWithNintendoAccount || Returns an [[#IOAuthProcedureForExternalNsa]].
|-
| 299 || SuspendBackgroundDaemon || Returns an [[#ISessionObject]].
|-
| 900 || [13.0.0+] SetUserUnqualifiedForDebug ||
|-
| 901 || [13.0.0+] UnsetUserUnqualifiedForDebug ||
|-
| 902 || [13.0.0+] ListUsersUnqualifiedForDebug ||
|-
| 997 || [3.0.0+] DebugInvalidateTokenCacheForUser ||
|-
| 998 || DebugSetUserStateClose ||
|-
| 999 || DebugSetUserStateOpen ||
|}


[10.0.0+] DebugSetUserStateClose/DebugSetUserStateOpen now takes an additional 8-bytes of input.
== GetShellEvent ==
Wrapper for "pm:shell" [[Process_Manager_services#pm:shell|GetProcessEventHandle]].


== IsUserRegistrationRequestPermitted ==
== GetShellEventInfo ==
Takes a PID, an input u64 pid_reserved, and returns an output u8 bool.
Wrapper for "pm:shell" [[Process_Manager_services#pm:shell|GetProcessEventInfo]].


== TrySelectUserWithoutInteraction ==
== TerminateApplication ==
Takes an input u8 bool isNetworkServiceAccountRequired, returns an output Uid.
Calls "pm:shell" [[Process_Manager_services#pm:shell|GetApplicationProcessIdForShell]] and sends the ProcessId to [[Process_Manager_services#pm:shell|TerminateProcess]].
 
== PrepareLaunchProgramFromHost ==
Takes a type-0x5 input buffer containing the [[Filesystem_services#FspPath|FspPath]], returns an output 0x10-byte struct.
 
Calls [[NCM_services#IPathResolverForStorage|IPathResolverForStorage]] Set...NcaPath functions.
 
== LaunchApplicationFromHost ==
Takes an input u32 [[Process_Manager_services#LaunchFlags|LaunchFlags]] and a type-0x5 input buffer containing the [[Filesystem_services#FspPath|FspPath]]. Returns an output u64 ProcessId.
 
== LaunchApplicationWithStorageId ==
Takes 2 input u8 [[NCM_services#StorageId|StorageIds]], an u32 [[Process_Manager_services#LaunchFlags|LaunchFlags]], and an [[NCM_services#ApplicationId|ApplicationId]]. Returns an output u64 ProcessId.
 
Launches an application title which is registered with NS.
 
== IsSystemMemoryResourceLimitBoosted ==
No input. Returns a bool.
 
== GetRunningApplicationProcessId ==
Returns an output u64 ProcessId.
 
== SetCurrentApplicationRightsEnvironmentCanBeActive ==
Takes an input bool. No output.


== IManagerForSystemService ==
== CreateApplicationResource ==
This is "nn::account::baas::IManagerForSystemService".
Takes an input u32 (1 = Preomia/MicroApplication). Returns an [[#IApplicationResource]].


{| class="wikitable" border="1"
== IsPreomia ==
|-
Takes an input u64 [[NCM_services#ProgramId|ProgramId]]. Returns a bool.
! Cmd || Name || Notes
 
|-
== GetApplicationProgramIdFromHost ==
| 0 || CheckAvailability ||
Takes a type-0x5 input buffer containing the [[Filesystem_services#FspPath|FspPath]]. Returns an u64 [[NCM_services#ProgramId|ProgramId]].
|-
 
| 1 || GetAccountId ||
== PrepareLaunchApplicationFromHost ==
|-
[18.0.0+] Now returns a total of 0x50 bytes of output.
| 2 || EnsureIdTokenCacheAsync || Returns an [[#IAsyncContext]].
 
|-
[19.0.0+] Now returns a total of 0x80 bytes of output.
| 3 || LoadIdTokenCache ||
 
|-
== GetLaunchEvent ==
| 100 || SetSystemProgramIdentification ||
[18.0.0+] Now takes a total of 0x50 bytes of input.
|-
 
| 101 || [7.0.0+] RefreshNotificationTokenAsync ||
[19.0.0+] Now takes a total of 0x80 bytes of input.
|-
 
| 110 || [4.0.0+] GetServiceEntryRequirementCache ||
== GetLaunchResult ==
[18.0.0+] Now takes a total of 0x50 bytes of input.
 
[19.0.0+] Now takes a total of 0x80 bytes of input.
 
== PrepareLaunchApplication ==
Takes a total of 0x10-bytes of input. Returns a total of 0x50-bytes of output.
 
[19.0.0+] Now returns a total of 0x80-bytes of output.
 
== LaunchApplication ==
Takes a total of 0x50-bytes of input. Returns a total of 8-bytes of output.
 
[19.0.0+] Now takes a total of 0x80 bytes of input.
 
== GetProgramIdByApplicationLaunchInfo ==
Takes a total of 0x50-bytes of input. Returns a total of 8-bytes of output.
 
[19.0.0+] Now takes a total of 0x80 bytes of input.
 
= acc:su =
This is "nn::account::IAccountServiceForAdministrator".
 
[13.0.0+] This was moved from [[Account_services|account]].
 
This is only available when the output from [[Process_Manager_services|pm:bm]] GetBootMode is Normal/Maintenance.
 
{| class="wikitable" border="1"
|-
|-
| 111 || [4.0.0+] InvalidateServiceEntryRequirementCache ||
! Cmd || Name || Notes
|-
|-
| 112 || [4.0.0-6.2.0] InvalidateTokenCache ||
| 0 || GetUserCount ||
|-
|-
| 113 || [6.1.0+] GetServiceEntryRequirementCacheForOnlinePlay || Takes a total of 0x8-bytes of input, returns a total of 0x4-bytes of output.
| 1 || GetUserExistence ||
|-
|-
| 120 || GetNintendoAccountId ||
| 2 || ListAllUsers ||
|-
|-
| 121 || [9.0.0+] CalculateNintendoAccountAuthenticationFingerprint ||
| 3 || ListOpenUsers ||
|-
|-
| 130 || GetNintendoAccountUserResourceCache ||
| 4 || GetLastOpenedUser ||
|-
|-
| 131 || RefreshNintendoAccountUserResourceCacheAsync || Returns an [[#IAsyncContext]].
| 5 || GetProfile || Returns an [[#IProfile]].
|-
|-
| 132 || RefreshNintendoAccountUserResourceCacheAsyncIfSecondsElapsed || Returns an [[#IAsyncContext]].
| 6 || [3.0.0+] GetProfileDigest ||
|-
|-
| 133 || [9.0.0+] GetNintendoAccountVerificationUrlCache ||
| 50 || [[#IsUserRegistrationRequestPermitted]] ||
|-
|-
| 134 || [9.0.0+] RefreshNintendoAccountVerificationUrlCacheAsync ||
| 51 || TrySelectUserWithoutInteractionDeprecated ([1.0.0-18.1.0] [[#TrySelectUserWithoutInteraction]]) ||
|-
|-
| 135 || [9.0.0+] RefreshNintendoAccountVerificationUrlCacheAsyncIfSecondsElapsed ||
| 52 || [19.0.0+] TrySelectUserWithoutInteraction ||
|-
|-
| 140 || [5.0.0+] GetNetworkServiceLicenseCache ||  
| 60 || [5.0.0-5.1.0] ListOpenContextStoredUsers ||
|-
|-
| 141 || [5.0.0+] RefreshNetworkServiceLicenseCacheAsync || Returns an [[#IAsyncContext]].
| 99 || [6.0.0+] DebugActivateOpenContextRetention || No input, returns an [[#ISessionObject]].
|-
|-
| 142 || [5.0.0+] RefreshNetworkServiceLicenseCacheAsyncIfSecondsElapsed || Returns an [[#IAsyncContext]].
| 100 || GetUserRegistrationNotifier || Returns an [[#INotifier]].
|-
|-
| 150 || CreateAuthorizationRequest || Returns an [[#IAuthorizationRequest]].
| 101 || GetUserStateChangeNotifier || Returns an [[#INotifier]].
|}
 
== IFloatingRegistrationRequest ==
This is "nn::account::baas::IFloatingRegistrationRequest".
 
Added with [3.0.0+].
 
{| class="wikitable" border="1"
|-
|-
! Cmd || Name || Notes
| 102 || GetBaasAccountManagerForSystemService || Returns an [[#IManagerForSystemService]].
|-
|-
| 0 || GetSessionId ||
| 103 || GetBaasUserAvailabilityChangeNotifier || Returns an [[#INotifier]].
|-
|-
| 12 || GetAccountId ||
| 104 || GetProfileUpdateNotifier || Returns an [[#INotifier]].
|-
|-
| 13 || GetLinkedNintendoAccountId ||
| 105 || [4.0.0+] CheckNetworkServiceAvailabilityAsync || Returns an [[#IAsyncContext]].
|-
|-
| 14 || GetNickname ||
| 106 || [9.0.0+] GetProfileSyncNotifier ||
|-
|-
| 15 || GetProfileImage ||
| 110 || StoreSaveDataThumbnail ||
|-
|-
| 21 || LoadIdTokenCache ||
| 111 || ClearSaveDataThumbnail ||
|-
|-
| 100 || RegisterUser ([1.0.0-3.0.2] RegisterAsync) || [1.0.0-3.0.2] Used to return an [[#IAsyncContext]].
| 112 || LoadSaveDataThumbnail ||
|-
|-
| 101 || RegisterUserWithUid ([1.0.0-3.0.2] RegisterWithUidAsync) || [1.0.0-3.0.2] Used to return an [[#IAsyncContext]].
| 113 || [5.0.0+] GetSaveDataThumbnailExistence ||
|-
|-
| 102 || [4.0.0+] RegisterNetworkServiceAccountAsync || Returns an [[#IAsyncContext]].
| 120 || [10.0.0+] ListOpenUsersInApplication ||
|-
|-
| 103 || [4.0.0+] RegisterNetworkServiceAccountWithUidAsync || Returns an [[#IAsyncContext]].
| 130 || [6.0.0+] ActivateOpenContextRetention || Takes a total of 0x8-bytes of input, returns an [[#ISessionObject]].
|-
|-
| 110 || SetSystemProgramIdentification ||
| 140 || [6.0.0+] ListQualifiedUsers ||  
|-
|-
| 111 || EnsureIdTokenCacheAsync || Returns an [[#IAsyncContext]].
| 150 || [10.0.0-10.2.0] AuthenticateApplicationAsync ||  
|}
 
== IAdministrator ==
This is "nn::account::baas::IAdministrator".
 
{| class="wikitable" border="1"
|-
|-
! Cmd || Name || Notes
| 151 || [12.0.0+] EnsureSignedDeviceIdentifierCacheForNintendoAccountAsync ||  
|-
|-
| 0 || CheckAvailability ||
| 152 || [12.0.0+] LoadSignedDeviceIdentifierCacheForNintendoAccount ||
|-
|-
| 1 || GetAccountId ||
| 170 || [13.0.0+] GetNasOp2MembershipStateChangeNotifier ||
|-
|-
| 2 || EnsureIdTokenCacheAsync || Returns an [[#IAsyncContext]].
| 190 || [1.0.0-9.2.0] GetUserLastOpenedApplication ||
|-
|-
| 3 || LoadIdTokenCache ||
| 191 || [7.0.0-19.0.1] UpdateNotificationReceiverInfo ([5.0.0-5.1.0] ActivateOpenContextHolder) ||
|-
|-
| 100 || SetSystemProgramIdentification ||
| 200 || BeginUserRegistration ||
|-
|-
| 101 || [7.0.0+] RefreshNotificationTokenAsync
| 201 || CompleteUserRegistration ||
|-
|-
| 110 || [4.0.0+] GetServiceEntryRequirementCache ||
| 202 || CancelUserRegistration ||
|-
|-
| 111 || [4.0.0+] InvalidateServiceEntryRequirementCache ||
| 203 || DeleteUser ||
|-
|-
| 112 || [4.0.0-6.2.0] InvalidateTokenCache ||
| 204 || SetUserPosition ||
|-
|-
| 113 || [6.1.0+] GetServiceEntryRequirementCacheForOnlinePlay || Takes a total of 0x8-bytes of input, returns a total of 0x4-bytes of output.
| 205 || GetProfileEditor || Takes an input userID and returns an [[#IProfileEditor]].
|-
|-
| 120 || GetNintendoAccountId ||
| 206 || CompleteUserRegistrationForcibly ||
|-
|-
| 121 || [9.0.0+] CalculateNintendoAccountAuthenticationFingerprint ||
| 210 || [3.0.0+] CreateFloatingRegistrationRequest || Returns an [[#IFloatingRegistrationRequest]].
|-
|-
| 130 || GetNintendoAccountUserResourceCache ||
| 211 || [8.0.0+] CreateProcedureToRegisterUserWithNintendoAccount || Takes a total of 0x4-bytes of input and a handle, returns an [[#IOAuthProcedureForUserRegistration]].
|-
|-
| 131 || RefreshNintendoAccountUserResourceCacheAsync || Returns an [[#IAsyncContext]].
| 212 || [8.0.0+] ResumeProcedureToRegisterUserWithNintendoAccount || Takes a total of 0x14-bytes of input and a handle, returns an [[#IOAuthProcedureForUserRegistration]].
|-
|-
| 132 || RefreshNintendoAccountUserResourceCacheAsyncIfSecondsElapsed || Returns an [[#IAsyncContext]].
| 213 || [17.0.0+] CreateProcedureToCreateUserWithNintendoAccount ||
|-
|-
| 133 || [9.0.0+] GetNintendoAccountVerificationUrlCache ||
| 214 || [17.0.0+] ResumeProcedureToCreateUserWithNintendoAccount ||
|-
| 215 || [17.0.0+] ResumeProcedureToCreateUserWithNintendoAccountAfterApplyResponse ||
|-
|-
| 134 || [9.0.0+] RefreshNintendoAccountVerificationUrlCacheAsync ||
| 230 || AuthenticateServiceAsync || Returns an [[#IAsyncContext]].
|-
|-
| 135 || [9.0.0+] RefreshNintendoAccountVerificationUrlCacheAsyncIfSecondsElapsed ||
| 250 || GetBaasAccountAdministrator || Returns an [[#IAdministrator]].
|-
|-
| 140 || [5.0.0+] GetNetworkServiceLicenseCache ||
| 251 || [20.0.0+] SynchronizeNetworkServiceAccountsSnapshotAsync ||
|-
|-
| 141 || [5.0.0+] RefreshNetworkServiceLicenseCacheAsync ||
| 290 || ProxyProcedureForGuestLoginWithNintendoAccount || Returns an [[#IOAuthProcedureForExternalNsa]] (formerly [[#IOAuthProcedureForGuestLogin]] with [1.0.0-2.3.0]).
|-
|-
| 142 || [5.0.0+] RefreshNetworkServiceLicenseCacheAsyncIfSecondsElapsed ||
| 291 || [3.0.0+] ProxyProcedureForFloatingRegistrationWithNintendoAccount || Returns an [[#IOAuthProcedureForExternalNsa]].
|-
|-
| 150 || CreateAuthorizationRequest || Returns an [[#IAuthorizationRequest]].
| 292 || [20.0.0+] ProxyProcedureForDeviceMigrationAuthenticatingOperatingUser ||
|-
|-
| 200 || IsRegistered ||
| 293 || [20.0.0+] ProxyProcedureForDeviceMigrationDownload ||
|-
|-
| 201 || RegisterAsync || Returns an [[#IAsyncContext]].
| 299 || SuspendBackgroundDaemon || Returns an [[#ISessionObject]].
|-
|-
| 202 || UnregisterAsync || Returns an [[#IAsyncContext]].
| 350 || [20.0.0+] CreateDeviceMigrationUserExportRequest ||
|-
|-
| 203 || DeleteRegistrationInfoLocally ||
| 351 || [20.0.0+] UploadNasCredential ||
|-
|-
| 220 || SynchronizeProfileAsync || Returns an [[#IAsyncContext]].
| 352 || [20.0.0+] CreateDeviceMigrationUserImportRequest ||
|-
|-
| 221 || UploadProfileAsync || Returns an [[#IAsyncContext]].
| 353 || [20.0.0+] DeleteUserMigrationSaveData ||
|-
|-
| 222 || SynchronizeProfileAsyncIfSecondsElapsed || Returns an [[#IAsyncContext]].
| 400 || [18.0.0+] SetPinCode ||
|-
|-
| 250 || IsLinkedWithNintendoAccount ||
| 401 || [18.0.0+] GetPinCodeLength ||
|-
|-
| 251 || CreateProcedureToLinkWithNintendoAccount || Returns an [[#IOAuthProcedureForNintendoAccountLinkage]].
| 402 || [18.0.0-19.0.1] GetPinCode ||
|-
|-
| 252 || ResumeProcedureToLinkWithNintendoAccount || Returns an [[#IOAuthProcedureForNintendoAccountLinkage]].
| 403 || [20.0.0+] GetPinCodeParity ||
|-
|-
| 255 || CreateProcedureToUpdateLinkageStateOfNintendoAccount || Returns an [[#IOAuthProcedure]].
| 404 || [20.0.0+] VerifyPinCode ||
|-
|-
| 256 || ResumeProcedureToUpdateLinkageStateOfNintendoAccount || Returns an [[#IOAuthProcedure]].
| 405 || [20.0.0+] IsPinCodeVerificationForbidden ||
|-
|-
| 260 || [3.0.0+] CreateProcedureToLinkNnidWithNintendoAccount || Returns an [[#IOAuthProcedure]].
| 410 || [18.0.0+] GetPinCodeErrorCount ||
|-
|-
| 261 || [3.0.0+] ResumeProcedureToLinkNnidWithNintendoAccount || Returns an [[#IOAuthProcedure]].
| 411 || [18.0.0-19.0.1] ResetPinCodeErrorCount ||
|-
|-
| 280 || ProxyProcedureToAcquireApplicationAuthorizationForNintendoAccount || Returns an [[#IOAuthProcedure]].
| 412 || [18.0.0-19.0.1] IncrementPinCodeErrorCount ||
|-
|-
| 290 || [8.0.0+] GetRequestForNintendoAccountUserResourceView ||  
| 413 || [20.0.0+] SetPinCodeErrorCount ||
|-
|-
| 300 || [6.0.0+] TryRecoverNintendoAccountUserStateAsync || Returns an [[#IAsyncContext]].
| 420 || [19.0.0+] SetStartPenaltyTime ||  
|-
|-
| 400 || [6.1.0+] IsServiceEntryRequirementCacheRefreshRequiredForOnlinePlay || Takes a total of 0x8-bytes of input, returns an output u8.
| 421 || [19.0.0+] GetStartPenaltyTime ||  
|-
|-
| 401 || [6.1.0+] RefreshServiceEntryRequirementCacheForOnlinePlayAsync || Takes a total of 0x8-bytes of input, returns an [[#IAsyncContext]].
| 900 || [13.0.0+] SetUserUnqualifiedForDebug ||
|-
|-
| 410 || [13.1.0+] CheckRequiredLicenseForLexAsync ||
| 901 || [13.0.0+] UnsetUserUnqualifiedForDebug ||
|-
|-
| 900 || [9.0.0+] GetAuthenticationInfoForWin ||
| 902 || [13.0.0+] ListUsersUnqualifiedForDebug ||
|-
|-
| 901 || [9.0.0+] ImportAsyncForWin ||
| 910 || [16.0.0+] RefreshFirmwareSettingsForDebug ||
|-
|-
| 997 || DebugUnlinkNintendoAccountAsync || Returns an [[#IAsyncContext]].
| 997 || [3.0.0+] DebugInvalidateTokenCacheForUser ||
|-
|-
| 998 || DebugSetAvailabilityErrorDetail ||
| 998 || DebugSetUserStateClose ||
|-
| 999 || DebugSetUserStateOpen ||
|}
|}


== IAuthorizationRequest ==
[10.0.0+] DebugSetUserStateClose/DebugSetUserStateOpen now takes an additional 8-bytes of input.
This is "nn::account::nas::IAuthorizationRequest".
 
== IsUserRegistrationRequestPermitted ==
Takes a PID, an input u64 pid_reserved, and returns an output u8 bool.
 
== TrySelectUserWithoutInteraction ==
Takes an input u8 bool isNetworkServiceAccountRequired, returns an output Uid.
 
== IManagerForSystemService ==
This is "nn::account::baas::IManagerForSystemService".


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 2,945: Line 3,179:
! Cmd || Name || Notes
! Cmd || Name || Notes
|-
|-
| 0 || GetSessionId ||
| 0 || CheckAvailability ||
|-
| 1 || GetAccountId ||
|-
|-
| 10 || InvokeWithoutInteractionAsync || Returns an [[#IAsyncContext]].
| 2 || EnsureIdTokenCacheAsync || Returns an [[#IAsyncContext]].
|-
|-
| 19 || IsAuthorized ||
| 3 || [19.0.0+] LoadIdTokenCacheDeprecated ([1.0.0-18.1.0] LoadIdTokenCache) ||
|-
|-
| 20 || GetAuthorizationCode ||
| 4 || [19.0.0+] LoadIdTokenCache ||
|-
|-
| 21 || GetIdToken ||
| 100 || SetSystemProgramIdentification ||
|-
|-
| 22 || GetState ||
| 101 || RefreshNotificationTokenAsync ||  
|}
 
== IOAuthProcedure ==
This is "nn::account::http::IOAuthProcedure".
 
{| class="wikitable" border="1"
|-
|-
! Cmd || Name || Notes
| 110 || GetServiceEntryRequirementCacheForLogin ||
|-
|-
| 0 || PrepareAsync || Returns an [[#IAsyncContext]].
| 111 || InvalidateServiceEntryRequirementCache ||
|-
|-
| 1 || GetRequest ||
| 113 || GetServiceEntryRequirementCacheForOnlinePlay || Takes a total of 0x8-bytes of input, returns a total of 0x4-bytes of output.
|-
|-
| 2 || ApplyResponse ||
| 120 || GetNintendoAccountId ||
|-
|-
| 3 || ApplyResponseAsync || Returns an [[#IAsyncContext]].
| 121 || CalculateNintendoAccountAuthenticationFingerprint ||
|-
|-
| 10 || Suspend ||
| 130 || GetNintendoAccountUserResourceCache ||
|}
|-
 
| 131 || RefreshNintendoAccountUserResourceCacheAsync || Returns an [[#IAsyncContext]].
== IOAuthProcedureForExternalNsa ==
|-
This is "nn::account::nas::IOAuthProcedureForExternalNsa".
| 132 || RefreshNintendoAccountUserResourceCacheAsyncIfSecondsElapsed || Returns an [[#IAsyncContext]].
 
|-
Added with [3.0.0+].
| 133 || GetNintendoAccountVerificationUrlCache ||
 
|-
{| class="wikitable" border="1"
| 134 || RefreshNintendoAccountVerificationUrlCacheAsync ||
|-
| 135 || RefreshNintendoAccountVerificationUrlCacheAsyncIfSecondsElapsed ||
|-
| 136 || [19.0.0+] GetNintendoAccountUserResourceCache ||
|-
|-
! Cmd || Name || Notes
| 140 || GetNetworkServiceLicenseCache ||  
|-
|-
| 0 || PrepareAsync || Returns an [[#IAsyncContext]].
| 141 || RefreshNetworkServiceLicenseCacheAsync || Returns an [[#IAsyncContext]].
|-
|-
| 1 || GetRequest ||
| 142 || RefreshNetworkServiceLicenseCacheAsyncIfSecondsElapsed || Returns an [[#IAsyncContext]].
|-
|-
| 2 || ApplyResponse ||
| 143 || [15.0.0+] GetNetworkServiceLicenseCacheEx ||
|-
|-
| 3 || ApplyResponseAsync || Returns an [[#IAsyncContext]].
| 150 || CreateAuthorizationRequest || Returns an [[#IAuthorizationRequest]].
|-
|-
| 10 || Suspend ||
| 160 || [15.0.0+] RequiresUpdateNetworkServiceAccountIdTokenCache ||
|-
|-
| 100 || GetAccountId ||
| 161 || [16.0.0+] RequireReauthenticationOfNetworkServiceAccount ||
|-
|-
| 101 || GetLinkedNintendoAccountId ||
| 180 || [18.0.0-19.0.1] GetRequestForNintendoAccountReauthentication ||
|-
|-
| 102 || GetNickname ||
| 181 || [20.0.0+] CreateProcedureToReauthenticateNintendoAccount ||
|-
|-
| 103 || GetProfileImage ||
| 182 || [20.0.0+] ResumeProcedureToReauthenticateNintendoAccount ||
|}
|}


== IOAuthProcedureForNintendoAccountLinkage ==
== IFloatingRegistrationRequest ==
This is "nn::account::nas::IOAuthProcedureForNintendoAccountLinkage".
This is "nn::account::baas::IFloatingRegistrationRequest".
 
Added with [3.0.0+].


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 3,011: Line 3,247:
! Cmd || Name || Notes
! Cmd || Name || Notes
|-
|-
| 0 || PrepareAsync || Returns an [[#IAsyncContext]].
| 0 || GetSessionId ||
|-
|-
| 1 || GetRequest ||
| 12 || GetAccountId ||
|-
|-
| 2 || ApplyResponse ||
| 13 || GetLinkedNintendoAccountId ||
|-
|-
| 3 || ApplyResponseAsync || Returns an [[#IAsyncContext]].
| 14 || GetNickname ||
|-
| 15 || GetProfileImage ||
|-
| 16 || [18.0.0+] GetProfileLargeImage ||
|-
| 21 || LoadIdTokenCache ||
|-
| 100 || RegisterUser ([1.0.0-3.0.2] RegisterAsync) || [1.0.0-3.0.2] Used to return an [[#IAsyncContext]].
|-
| 101 || RegisterUserWithUid ([1.0.0-3.0.2] RegisterWithUidAsync) || [1.0.0-3.0.2] Used to return an [[#IAsyncContext]].
|-
|-
| 10 || Suspend ||
| 102 || [4.0.0+] RegisterNetworkServiceAccountAsync || Returns an [[#IAsyncContext]].
|-
|-
| 100 || GetRequestWithTheme ||
| 103 || [4.0.0+] RegisterNetworkServiceAccountWithUidAsync || Returns an [[#IAsyncContext]].
|-
|-
| 101 || IsNetworkServiceAccountReplaced ||
| 110 || SetSystemProgramIdentification ||
|-
|-
| 199 || [2.0.0-5.1.0] GetUrlForIntroductionOfExtraMembership ||
| 111 || EnsureIdTokenCacheAsync || Returns an [[#IAsyncContext]].
|}
|}


== INotifier ==
== IAdministrator ==
This is "nn::account::detail::INotifier".
This is "nn::account::baas::IAdministrator".


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Cmd || Name
! Cmd || Name || Notes
|-
|-
| 0 || GetSystemEvent
| 0 || CheckAvailability ||
|}
 
== IProfile ==
This is "nn::account::profile::IProfile".
 
{| class="wikitable" border="1"
|-
|-
! Cmd || Name
| 1 || GetAccountId ||
|-
|-
| 0 || [[#Get]]
| 2 || EnsureIdTokenCacheAsync || Returns an [[#IAsyncContext]].
|-
|-
| 1 || [[#GetBase]]
| 3 || [19.0.0+] LoadIdTokenCacheDeprecated ([1.0.0-18.1.0] LoadIdTokenCache) ||
|-
|-
| 10 || [[#GetImageSize]]
| 4 || [19.0.0+] LoadIdTokenCache ||
|-
|-
| 11 || [[#LoadImage]]
| 100 || SetSystemProgramIdentification ||
|}
|-
 
| 101 || [7.0.0+] RefreshNotificationTokenAsync
=== Get ===
|-
Takes an output type-0x1A buffer for [[#UserData]], returns an output [[#ProfileBase]].
| 110 || [4.0.0+] GetServiceEntryRequirementCache ||
 
=== GetBase ===
No input, returns an output [[#ProfileBase]].
 
=== GetImageSize ===
No input, returns an output u32 for the size of the image buffer.
 
=== LoadImage ===
Takes an output type-0x6 buffer, returns the same output u32 as [[#GetImageSize]].
 
The output buffer contains the JPEG profile image icon. This is valid for both Miis and character icons.
 
== IProfileEditor ==
This is "nn::account::profile::IProfileEditor".
 
{| class="wikitable" border="1"
|-
|-
! Cmd || Name
| 111 || [4.0.0+] InvalidateServiceEntryRequirementCache ||
|-
|-
| 0 || [[#Get]]
| 112 || [4.0.0-6.2.0] InvalidateTokenCache ||
|-
|-
| 1 || [[#GetBase]]
| 113 || [6.1.0+] GetServiceEntryRequirementCacheForOnlinePlay || Takes a total of 0x8-bytes of input, returns a total of 0x4-bytes of output.
|-
|-
| 10 || [[#GetImageSize]]
| 120 || GetNintendoAccountId ||
|-
|-
| 11 || [[#LoadImage]]
| 121 || [9.0.0+] CalculateNintendoAccountAuthenticationFingerprint ||
|-
|-
| 100 || [[#Store]]
| 130 || GetNintendoAccountUserResourceCache ||
|-
|-
| 101 || [[#StoreWithImage]]
| 131 || RefreshNintendoAccountUserResourceCacheAsync || Returns an [[#IAsyncContext]].
|}
 
=== Store ===
Takes a [[#ProfileBase]] and an input type-0x19 buffer for [[#UserData]].
 
=== StoreWithImage ===
Takes a [[#ProfileBase]], an input type-0x19 buffer for [[#UserData]], and an input type-0x5 buffer.
 
== IAsyncContext ==
This is "nn::account::detail::IAsyncContext".
 
{| class="wikitable" border="1"
|-
|-
! Cmd || Name
| 132 || RefreshNintendoAccountUserResourceCacheAsyncIfSecondsElapsed || Returns an [[#IAsyncContext]].
|-
|-
| 0 || GetSystemEvent
| 133 || [9.0.0+] GetNintendoAccountVerificationUrlCache ||
|-
|-
| 1 || Cancel
| 134 || [9.0.0+] RefreshNintendoAccountVerificationUrlCacheAsync ||
|-
|-
| 2 || HasDone
| 135 || [9.0.0+] RefreshNintendoAccountVerificationUrlCacheAsyncIfSecondsElapsed ||
|-
|-
| 3 || GetResult
| 136 || [19.0.0+] GetNintendoAccountUserResourceCache ||
|}
 
== ISessionObject ==
This is "nn::account::detail::ISessionObject".
 
{| class="wikitable" border="1"
|-
|-
! Cmd || Name
| 140 || [5.0.0+] GetNetworkServiceLicenseCache ||
|-
|-
| 999 || Dummy
| 141 || [5.0.0+] RefreshNetworkServiceLicenseCacheAsync ||
|}
 
= acc:u0 =
This is "nn::account::IAccountServiceForApplication".
 
[13.0.0+] This was moved from [[Account_services|account]].
 
This is only available when the output from [[Process_Manager_services|pm:bm]] GetBootMode is Normal/Maintenance.
 
{| class="wikitable" border="1"
|-
|-
! Cmd || Name || Notes
| 142 || [5.0.0+] RefreshNetworkServiceLicenseCacheAsyncIfSecondsElapsed ||
|-
|-
| 0 || GetUserCount ||
| 143 || [15.0.0+] GetNetworkServiceLicenseCacheEx ||
|-
|-
| 1 || GetUserExistence ||
| 150 || CreateAuthorizationRequest || Returns an [[#IAuthorizationRequest]].
|-
|-
| 2 || ListAllUsers ||
| 160 || [15.0.0+] RequiresUpdateNetworkServiceAccountIdTokenCache ||
|-
|-
| 3 || ListOpenUsers ||
| 161 || [16.0.0+] RequireReauthenticationOfNetworkServiceAccount ||
|-
|-
| 4 || GetLastOpenedUser ||
| 180 || [18.0.0-19.0.1] GetRequestForNintendoAccountReauthentication ||
|-
|-
| 5 || GetProfile || Takes an input userID, returns an [[#IProfile]].
| 181 || [20.0.0+] CreateProcedureToReauthenticateNintendoAccount ||
|-
|-
| 6 || [3.0.0+] GetProfileDigest ||
| 182 || [20.0.0+] ResumeProcedureToReauthenticateNintendoAccount ||
|-
|-
| 50 || [[#IsUserRegistrationRequestPermitted]] ||
| 200 || IsRegistered ||
|-
|-
| 51 || [[#TrySelectUserWithoutInteraction]] ||
| 201 || RegisterAsync || Returns an [[#IAsyncContext]].
|-
|-
| 60 || [5.0.0-5.1.0] ListOpenContextStoredUsers ||
| 202 || UnregisterAsync || Returns an [[#IAsyncContext]].
|-
|-
| 99 || [6.0.0+] DebugActivateOpenContextRetention || No input, returns an [[#ISessionObject]].
| 203 || DeleteRegistrationInfoLocally ||
|-
|-
| 100 || [[#InitializeApplicationInfoV0]] ||
| 204 || [19.0.0-19.0.1] UnregisterDeviceAsync ||
|-
|-
| 101 || GetBaasAccountManagerForApplication || Takes an input userID, returns an [[#IManagerForApplication]].
| 220 || SynchronizeProfileAsync || Returns an [[#IAsyncContext]].
|-
|-
| 102 || AuthenticateApplicationAsync || Returns an [[#IAsyncContext]].
| 221 || UploadProfileAsync || Returns an [[#IAsyncContext]].
|-
|-
| 103 || [4.0.0+] CheckNetworkServiceAvailabilityAsync || Returns an [[#IAsyncContext]].
| 222 || SynchronizeProfileAsyncIfSecondsElapsed || Returns an [[#IAsyncContext]].
|-
|-
| 110 || StoreSaveDataThumbnail ||
| 223 || [19.0.0+] DownloadProfileAsync ||
|-
|-
| 111 || ClearSaveDataThumbnail ||
| 250 || IsLinkedWithNintendoAccount ||
|-
|-
| 120 || CreateGuestLoginRequest || Returns an [[#IGuestLoginRequest]].
| 251 || CreateProcedureToLinkWithNintendoAccount || Returns an [[#IOAuthProcedureForNintendoAccountLinkage]].
|-
|-
| 130 || [5.0.0+] LoadOpenContext ||
| 252 || ResumeProcedureToLinkWithNintendoAccount || Returns an [[#IOAuthProcedureForNintendoAccountLinkage]].
|-
|-
| 131 || [6.0.0+] ListOpenContextStoredUsers ||
| 255 || CreateProcedureToUpdateLinkageStateOfNintendoAccount || Returns an [[#IOAuthProcedure]].
|-
|-
| 140 || [6.0.0+] [[#InitializeApplicationInfoV1]] ||
| 256 || ResumeProcedureToUpdateLinkageStateOfNintendoAccount || Returns an [[#IOAuthProcedure]].
|-
|-
| 141 || [6.0.0+] ListQualifiedUsers ||  
| 260 || [3.0.0+] CreateProcedureToLinkNnidWithNintendoAccount || Returns an [[#IOAuthProcedure]].
|-
|-
| 150 || [6.0.0+] IsUserAccountSwitchLocked ||  
| 261 || [3.0.0+] ResumeProcedureToLinkNnidWithNintendoAccount || Returns an [[#IOAuthProcedure]].
|-
|-
| 160 || [13.0.0+] InitializeApplicationInfoV2 ||  
| 280 || ProxyProcedureToAcquireApplicationAuthorizationForNintendoAccount || Returns an [[#IOAuthProcedure]].
|}
 
InitializeApplicationInfo* is used by the user-process during service init.
 
== InitializeApplicationInfoV0 ==
Takes a PID and an input u64 pid_placeholder, no output.
 
== InitializeApplicationInfoV1 ==
Takes a PID and an input u64 pid_placeholder, no output.
 
== IGuestLoginRequest ==
This is "nn::account::baas::IGuestLoginRequest".
 
{| class="wikitable" border="1"
|-
|-
! Cmd || Name
| 290 || [8.0.0+] GetRequestForNintendoAccountUserResourceView ||  
|-
|-
| 0 || GetSessionId
| 300 || [6.0.0+] TryRecoverNintendoAccountUserStateAsync || Returns an [[#IAsyncContext]].
|-
|-
| 11 || [1.0.0-2.3.0]
| 400 || [6.1.0+] IsServiceEntryRequirementCacheRefreshRequiredForOnlinePlay || Takes a total of 0x8-bytes of input, returns an output u8.
|-
|-
| 12 || GetAccountId
| 401 || [6.1.0+] RefreshServiceEntryRequirementCacheForOnlinePlayAsync || Takes a total of 0x8-bytes of input, returns an [[#IAsyncContext]].
|-
|-
| 13 || GetLinkedNintendoAccountId
| 900 || [9.0.0+] GetAuthenticationInfoForWin ||
|-
|-
| 14 || GetNickname
| 901 || [9.0.0+] ImportAsyncForWin ||
|-
|-
| 15 || GetProfileImage
| 997 || DebugUnlinkNintendoAccountAsync || Returns an [[#IAsyncContext]].
|-
|-
| 21 || [3.0.0+] LoadIdTokenCache
| 998 || DebugSetAvailabilityErrorDetail ||
|}
|}


== IManagerForApplication ==
== IAuthorizationRequest ==
This is "nn::account::baas::IManagerForApplication".
This is "nn::account::nas::IAuthorizationRequest".


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 3,217: Line 3,399:
! Cmd || Name || Notes
! Cmd || Name || Notes
|-
|-
| 0 || CheckAvailability ||
| 0 || GetSessionId ||
|-
|-
| 1 || GetAccountId ||
| 10 || InvokeWithoutInteractionAsync || Returns an [[#IAsyncContext]].
|-
|-
| 2 || EnsureIdTokenCacheAsync || Returns an [[#IAsyncContext]].
| 19 || IsAuthorized ||
|-
|-
| 3 || LoadIdTokenCache ||
| 20 || GetAuthorizationCode ||
|-
|-
| 130 || GetNintendoAccountUserResourceCacheForApplication ||
| 21 || GetIdToken ||
|-
|-
| 150 || CreateAuthorizationRequest || Returns an [[#IAuthorizationRequest]].
| 22 || GetState ||
|-
| 160 || [5.0.0+] StoreOpenContext ||
|-
| 170 || [13.0.0+] EnsureIdTokenCacheForOnlinePlayAsync ([6.0.0-12.1.0] LoadNetworkServiceLicenseKindAsync) || No input, returns an [[#IAsyncContextForLoginForOnlinePlay]] ([6.0.0-12.1.0] [[#IAsyncNetworkServiceLicenseKindContext]]).
|}
|}


== IAsyncNetworkServiceLicenseKindContext ==
== IOAuthProcedure ==
This is "nn::account::detail::IAsyncNetworkServiceLicenseKindContext".
This is "nn::account::http::IOAuthProcedure".
 
This was added with [6.0.0+].


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 3,243: Line 3,419:
! Cmd || Name || Notes
! Cmd || Name || Notes
|-
|-
| 0 || GetSystemEvent ||  
| 0 || PrepareAsync || Returns an [[#IAsyncContext]].
|-
|-
| 1 || Cancel ||  
| 1 || GetRequest ||
|-
|-
| 2 || HasDone ||  
| 2 || ApplyResponse ||
|-
|-
| 3 || GetResult ||  
| 3 || ApplyResponseAsync || Returns an [[#IAsyncContext]].
|-
|-
| 100 || GetNetworkServiceLicenseKind ||  
| 10 || Suspend ||
|}
|}


== IAsyncContextForLoginForOnlinePlay ==
== IOAuthProcedureForExternalNsa ==
This is "nn::account::baas::IAsyncContextForLoginForOnlinePlay".
This is "nn::account::nas::IOAuthProcedureForExternalNsa".


This was added with [13.0.0+].
Added with [3.0.0+].


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 3,263: Line 3,439:
! Cmd || Name || Notes
! Cmd || Name || Notes
|-
|-
| 0 || GetSystemEvent ||  
| 0 || PrepareAsync || Returns an [[#IAsyncContext]].
|-
|-
| 1 || Cancel ||  
| 1 || GetRequest ||
|-
|-
| 2 || HasDone ||  
| 2 || ApplyResponse ||
|-
|-
| 3 || GetResult ||  
| 3 || ApplyResponseAsync || Returns an [[#IAsyncContext]].
|-
|-
| 100 || GetNetworkServiceLicenseInfoForOnlinePlay ||  
| 10 || Suspend ||
|-
| 100 || GetAccountId ||
|-
| 101 || GetLinkedNintendoAccountId ||
|-
| 102 || GetNickname ||
|-
| 103 || GetProfileImage ||
|-
| 104 || [18.0.0+] GetProfileLargeImage ||
|}
|}


= acc:u1 =
== IOAuthProcedureForNintendoAccountLinkage ==
This is "nn::account::IAccountServiceForSystemService".
This is "nn::account::nas::IOAuthProcedureForNintendoAccountLinkage".
 
[13.0.0+] This was moved from [[Account_services|account]].
 
This is only available when the output from [[Process_Manager_services|pm:bm]] GetBootMode is Normal/Maintenance.


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 3,285: Line 3,467:
! Cmd || Name || Notes
! Cmd || Name || Notes
|-
|-
| 0 || GetUserCount ||
| 0 || PrepareAsync || Returns an [[#IAsyncContext]].
|-
|-
| 1 || GetUserExistence ||
| 1 || GetRequest ||
|-
|-
| 2 || ListAllUsers ||
| 2 || ApplyResponse ||
|-
|-
| 3 || ListOpenUsers ||
| 3 || ApplyResponseAsync || Returns an [[#IAsyncContext]].
|-
|-
| 4 || GetLastOpenedUser ||
| 10 || Suspend ||
|-
|-
| 5 || GetProfile || Returns an [[#IProfile]].
| 100 || GetRequestWithTheme ||
|-
|-
| 6 || [3.0.0+] GetProfileDigest ||
| 101 || IsNetworkServiceAccountReplaced ||
|-
|-
| 50 || [[#IsUserRegistrationRequestPermitted]] ||
| 199 || [2.0.0-5.1.0] GetUrlForIntroductionOfExtraMembership ||
|-
|-
| 51 || [[#TrySelectUserWithoutInteraction]] ||
| 200 || [16.0.0+] ApplyAsyncWithAuthorizedToken ||
|-
|}
| 60 || [5.0.0-5.1.0] ListOpenContextStoredUsers ||
 
== INotifier ==
This is "nn::account::detail::INotifier".
 
{| class="wikitable" border="1"
|-
|-
| 99 || [6.0.0+] DebugActivateOpenContextRetention || No input, returns an [[#ISessionObject]].
! Cmd || Name
|-
|-
| 100 || GetUserRegistrationNotifier || Returns an [[#INotifier]].
| 0 || GetSystemEvent
|}
 
== IProfile ==
This is "nn::account::profile::IProfile".
 
{| class="wikitable" border="1"
|-
|-
| 101 || GetUserStateChangeNotifier || Returns an [[#INotifier]].
! Cmd || Name
|-
|-
| 102 || GetBaasAccountManagerForSystemService || Returns an [[#IManagerForSystemService]].
| 0 || [[#Get]]
|-
|-
| 103 || GetBaasUserAvailabilityChangeNotifier || Returns an [[#INotifier]].
| 1 || [[#GetBase]]
|-
|-
| 104 || GetProfileUpdateNotifier || Returns an [[#INotifier]].
| 10 || [[#GetImageSize]]
|-
|-
| 105 || [4.0.0+] CheckNetworkServiceAvailabilityAsync || Returns an [[#IAsyncContext]].
| 11 || [[#LoadImage]]
|-
|-
| 106 || [9.0.0+] GetProfileSyncNotifier ||
| 20 || [18.0.0+] GetLargeImageSize
|-
|-
| 110 || StoreSaveDataThumbnail ||
| 21 || [18.0.0+] LoadLargeImage
|-
|-
| 111 || ClearSaveDataThumbnail ||
| 30 || [18.0.0+] GetImageId
|-
|}
| 112 || LoadSaveDataThumbnail ||
 
|-
=== Get ===
| 113 || [5.0.0+] GetSaveDataThumbnailExistence ||
Takes an output type-0x1A buffer for [[#UserData]], returns an output [[#ProfileBase]].
|-
 
| 120 || [10.0.0+] ListOpenUsersInApplication ||
=== GetBase ===
No input, returns an output [[#ProfileBase]].
 
=== GetImageSize ===
No input, returns an output u32 for the size of the image buffer.
 
=== LoadImage ===
Takes an output type-0x6 buffer, returns the same output u32 as [[#GetImageSize]].
 
The output buffer contains the JPEG profile image icon. This is valid for both Miis and character icons.
 
== IProfileEditor ==
This is "nn::account::profile::IProfileEditor".
 
{| class="wikitable" border="1"
|-
|-
| 130 || [6.0.0+] ActivateOpenContextRetention || Takes a total of 0x8-bytes of input, returns an [[#ISessionObject]].
! Cmd || Name
|-
|-
| 140 || [6.0.0+] ListQualifiedUsers ||
| 0 || [[#Get]]
|-
|-
| 150 || [10.0.0-10.2.0] AuthenticateApplicationAsync ||
| 1 || [[#GetBase]]
|-
|-
| 151 || [12.0.0+] EnsureSignedDeviceIdentifierCacheForNintendoAccountAsync ||
| 10 || [[#GetImageSize]]
|-
|-
| 152 || [12.0.0+] LoadSignedDeviceIdentifierCacheForNintendoAccount ||
| 11 || [[#LoadImage]]
|-
|-
| 170 || [13.0.0+] GetNasOp2MembershipStateChangeNotifier ||
| 20 || [18.0.0+] GetLargeImageSize
|-
|-
| 190 || [1.0.0-9.2.0] GetUserLastOpenedApplication ||
| 21 || [18.0.0+] LoadLargeImage
|-
|-
| 191 || [7.0.0+] UpdateNotificationReceiverInfo ([5.0.0-5.1.0] ActivateOpenContextHolder) ||
| 30 || [18.0.0+] GetImageId
|-
|-
| 997 || [3.0.0+] DebugInvalidateTokenCacheForUser ||
| 100 || [[#Store]]
|-
|-
| 998 || DebugSetUserStateClose ||
| 101 || [[#StoreWithImage]]
|-
|-
| 999 || DebugSetUserStateOpen ||
| 110 || [18.0.0+] StoreWithLargeImage
|}
|}


[10.0.0+] DebugSetUserStateClose/DebugSetUserStateOpen now takes an additional 8-bytes of input.  
=== Store ===
Takes a [[#ProfileBase]] and an input type-0x19 buffer for [[#UserData]].


== IOAuthProcedureForUserRegistration ==
=== StoreWithImage ===
This is "nn::account::nas::IOAuthProcedureForUserRegistration".
Takes a [[#ProfileBase]], an input type-0x19 buffer for [[#UserData]], and an input type-0x5 buffer.


This was added with [8.0.0+].
== IAsyncContext ==
This is "nn::account::detail::IAsyncContext".


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Cmd || Name || Notes
! Cmd || Name
|-
|-
| 0 || PrepareAsync || No input, returns an [[#IAsyncContext]].
| 0 || GetSystemEvent
|-
|-
| 1 || GetRequest ||
| 1 || Cancel
|-
|-
| 2 || ApplyResponse ||
| 2 || HasDone
|-
|-
| 3 || ApplyResponseAsync || Takes a type-0x9 input buffer, returns an [[#IAsyncContext]].
| 3 || GetResult
|}
 
== ISessionObject ==
This is "nn::account::detail::ISessionObject".
 
{| class="wikitable" border="1"
|-
|-
| 10 || Suspend ||  
! Cmd || Name
|-
|-
| 100 || GetAccountId ||  
| 999 || Dummy
|}
 
= acc:u0 =
This is "nn::account::IAccountServiceForApplication".
 
[13.0.0+] This was moved from [[Account_services|account]].
 
This is only available when the output from [[Process_Manager_services|pm:bm]] GetBootMode is Normal/Maintenance.
 
{| class="wikitable" border="1"
|-
|-
| 101 || GetLinkedNintendoAccountId ||  
! Cmd || Name || Notes
|-
|-
| 102 || GetNickname ||  
| 0 || GetUserCount ||
|-
|-
| 103 || GetProfileImage ||  
| 1 || GetUserExistence ||
|-
|-
| 110 || RegisterUserAsync || No input, returns an [[#IAsyncContext]].
| 2 || ListAllUsers ||
|-
|-
| 111 || GetUid ||  
| 3 || ListOpenUsers ||
|}
 
= VersionListData =
This is "nn::ns::VersionListData".
 
= ApplicationUpdateInfo =
This is "nn::ns::ApplicationUpdateInfo".
 
This is an u8. [[qlaunch]] just checks whether this is 0.
 
= ApplicationOccupiedSize =
This is "nn::ns::ApplicationOccupiedSize". This is a 0x80-byte struct.
 
= ProgressForDeleteUserSaveDataAll =
This is "nn::ns::detail::ProgressForDeleteUserSaveDataAll". This is a 0x28-byte struct.
 
= ApplicationViewDeprecated =
This is "nn::ns::ApplicationViewDeprecated". This is a 0x40-byte struct.
 
This is converted from [[#ApplicationView]] by [[#GetApplicationViewDeprecated]] on newer system-versions as follows:
 
{| class="wikitable" border="1"
|-
|-
! Offset
| 4 || GetLastOpenedUser ||
! Size
! Description
|-
|-
| 0x0 || 0x20 || Same as [[#ApplicationView]] +0x0.
| 5 || GetProfile || Takes an input userID, returns an [[#IProfile]].
|-
|-
| 0x20 || 0x4 || Same as [[#ApplicationView]] +0x20.
| 6 || [3.0.0+] GetProfileDigest ||
|-
|-
| 0x24 || 0x2 || Same as [[#ApplicationView]] +0x24.
| 50 || [[#IsUserRegistrationRequestPermitted]] ||
|-
|-
| 0x26 || 0x2 || Cleared to 0.
| 51 || TrySelectUserWithoutInteractionDeprecated ([1.0.0-18.1.0] [[#TrySelectUserWithoutInteraction]]) ||
|-
|-
| 0x28 || 0x10 || Same as [[#ApplicationView]] +0x30.
| 52 || [19.0.0+] TrySelectUserWithoutInteraction ||
|-
|-
| 0x38 || 0x4 || Same as [[#ApplicationView]] +0x40.
| 60 || [5.0.0-5.1.0] ListOpenContextStoredUsers ||
|-
|-
| 0x3C || 0x1 || Same as [[#ApplicationView]] +0x44.
| 99 || [6.0.0+] DebugActivateOpenContextRetention || No input, returns an [[#ISessionObject]].
|-
|-
| 0x3D || 0x2 || Cleared to 0.
| 100 || [[#InitializeApplicationInfoV0]] ||
|-
|-
| 0x3F || 0x1 || Cleared to 0.
| 101 || GetBaasAccountManagerForApplication || Takes an input userID, returns an [[#IManagerForApplication]].
|}
|-
 
| 102 || AuthenticateApplicationAsync || Returns an [[#IAsyncContext]].
= ApplicationView =
|-
This is "nn::ns::ApplicationView". This is a 0x50-byte struct.
| 103 || [4.0.0+] CheckNetworkServiceAvailabilityAsync || Returns an [[#IAsyncContext]].
 
|-
{| class="wikitable" border="1"
| 110 || StoreSaveDataThumbnail ||
|-
|-
! Offset
| 111 || ClearSaveDataThumbnail ||
! Size
! Description
|-
|-
| 0x0 || 0x8 || [[NCM_services#ApplicationId|ApplicationId]]
| 120 || CreateGuestLoginRequest || Returns an [[#IGuestLoginRequest]].
|-
|-
| 0x8 || 0x4 || ?
| 130 || [5.0.0+] LoadOpenContext ||
|-
|-
| 0xC || 0x4 || Flags
| 131 || [6.0.0+] ListOpenContextStoredUsers ||  
|-
|-
| 0x10 || 0x40 || ?
| 140 || [6.0.0+] [[#InitializeApplicationInfoV1]] ||  
|}
 
= ApplicationViewWithPromotionInfo =
This is a 0x70-byte struct.
 
{| class="wikitable" border="1"
|-
|-
! Offset
| 141 || [6.0.0+] ListQualifiedUsers ||
! Size
! Description
|-
|-
| 0x0 || 0x50 || [[#ApplicationView]]
| 150 || [6.0.0+] IsUserAccountSwitchLocked ||  
|-
|-
| 0x50 || 0x20 || [[#PromotionInfo]]
| 160 || [13.0.0+] InitializeApplicationInfoV2 ||  
|}
|}


= PromotionInfo =
InitializeApplicationInfo* is used by the user-process during service init.
This is a 0x20-byte struct.
 
== InitializeApplicationInfoV0 ==
Takes a PID and an input u64 pid_placeholder, no output.
 
== InitializeApplicationInfoV1 ==
Takes a PID and an input u64 pid_placeholder, no output.
 
== IGuestLoginRequest ==
This is "nn::account::baas::IGuestLoginRequest".


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset
! Cmd || Name
! Size
|-
! Description
| 0 || GetSessionId
|-
| 11 || [1.0.0-2.3.0]
|-
|-
| 0x0 || 0x8 || PosixTime start_timestamp.
| 12 || GetAccountId
|-
|-
| 0x8 || 0x8 || PosixTime end_timestamp.
| 13 || GetLinkedNintendoAccountId
|-
|-
| 0x10 || 0x8 || Remaining time until the promotion ends, in nanoseconds ({end_timestamp - current_time} converted to nanoseconds).
| 14 || GetNickname
|-
|-
| 0x18 || 0x4 || Not set, left at zero.
| 15 || GetProfileImage
|-
|-
| 0x1C || 0x1 || Flags. Bit0: whether the PromotionInfo is valid (including bit1). Bit1 clear: u64 +0x10 is set.
| 16 || [18.0.0+] GetProfileLargeImage
|-
|-
| 0x1D || 0x3 || Padding
| 21 || [3.0.0+] LoadIdTokenCache
|}
|}


= NoDownloadRightsErrorResolution =
== IManagerForApplication ==
This is "nn::ns::NoDownloadRightsErrorResolution".
This is "nn::account::baas::IManagerForApplication".


= BackgroundNetworkUpdateState =
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Value
! Cmd || Name || Notes
!  Description
|-
| 0 || CheckAvailability ||
|-
|-
| 0 || No sysupdate task exists.
| 1 || GetAccountId ||
|-
|-
| 1 || Sysupdate download in progress.
| 2 || EnsureIdTokenCacheAsync || Returns an [[#IAsyncContext]].
|-
|-
| 2 || Sysupdate ready, pending install.
| 3 || LoadIdTokenCache ||
|}
|-
 
| 130 || GetNintendoAccountUserResourceCacheForApplication ||
This is "nn::ns::BackgroundNetworkUpdateState". This is an u8.
 
Similar to [[#HasDownloaded]], [[#GetBackgroundNetworkUpdateState]] uses [[NIM_services|nim]] ListSystemUpdateTask and [[NIM_services|nim]] GetSystemUpdateTaskInfo. When ListSystemUpdateTask successfully returns a task and GetSystemUpdateTaskInfo is successful, the output value is set to: <code>1 + *((u8*)(taskinfo+0) == 0x3</code>. Otherwise, value=0.
 
[[#GetBackgroundNetworkUpdateState]] always returns Result 0, however this will assert if GetSystemUpdateTaskInfo fails with ret!=0x3C89.
 
= SystemUpdateProgress =
{| class="wikitable" border="1"
|-
|-
! Offset
| 150 || CreateAuthorizationRequest || Returns an [[#IAuthorizationRequest]].
! Size
! Description
|-
|-
| 0x0 || 0x8 || s64 Current size. This value can be larger than total_size when the async operation is finishing. When total_size is <=0, this current_size field may contain a progress value for when the total_size is not yet determined.
| 160 || [5.0.0+] StoreOpenContext ||
|-
|-
| 0x8 || 0x8 || s64 Total size, this field is only valid when >0.
| 170 || [13.0.0+] EnsureIdTokenCacheForOnlinePlayAsync ([6.0.0-12.1.0] LoadNetworkServiceLicenseKindAsync) || No input, returns an [[#IAsyncContextForLoginForOnlinePlay]] ([6.0.0-12.1.0] [[#IAsyncNetworkServiceLicenseKindContext]]).
|}
|}


This is "nn::ns::SystemUpdateProgress". This is a 0x10-byte struct.
== IAsyncNetworkServiceLicenseKindContext ==
This is "nn::account::detail::IAsyncNetworkServiceLicenseKindContext".


Commands which have this as output will return 0 with the output cleared, when no task is available.
This was added with [6.0.0+].
 
= EulaDataPath =
This is "nn::ns::detail::EulaDataPath". This is a 0x100-byte struct.


This contains a file path.
= SystemDeliveryInfo =
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset
! Cmd || Name || Notes
! Size
! Description
|-
|-
| 0x0 || 0x4 || SystemDeliveryProtocolVersion. Must be <= to and match [[System_Settings|system-setting]] <code>contents_delivery!system_delivery_protocol_version</code>.
| 0 || GetSystemEvent ||  
|-
|-
| 0x4 || 0x4 || ApplicationDeliveryProtocolVersion. Loaded from [[System_Settings|system-setting]] <code>contents_delivery!application_delivery_protocol_version</code>. Unused by [[#RequestSendSystemUpdate]]/[[#RequestReceiveSystemUpdate]], besides HMAC validation.
| 1 || Cancel ||  
|-
|-
| 0x8 || 0x1 || HasExFat. Unused by [[#RequestSendSystemUpdate]]/[[#RequestReceiveSystemUpdate]], besides HMAC validation.
| 2 || HasDone ||  
|-
|-
| 0x9 || 0x3 || Reserved.
| 3 || GetResult ||  
|-
|-
| 0xC || 0x4 || SystemUpdateMetaVersion.
| 100 || GetNetworkServiceLicenseKind ||  
|}
 
== IAsyncContextForLoginForOnlinePlay ==
This is "nn::account::baas::IAsyncContextForLoginForOnlinePlay".
 
This was added with [13.0.0+].
 
{| class="wikitable" border="1"
|-
|-
| 0x10 || 0x8 || SystemUpdateMetaId.
! Cmd || Name || Notes
|-
|-
| 0x18 || 0x1 || FirmwareVariationId. Used by [[#RequestSendSystemUpdate]].
| 0 || GetSystemEvent ||  
|-
|-
| 0x19 || 0x1 || UpdatableFirmwareGroupId. Unused by [[#RequestSendSystemUpdate]]/[[#RequestReceiveSystemUpdate]], besides HMAC validation.
| 1 || Cancel ||  
|-
|-
| 0x1A || 0x1 || PlatformRegion (0x00 = Unknown, 0x01 = Global, 0x02 = China).
| 2 || HasDone ||  
|-
|-
| 0x1B || 0xC5 || Unused by [[#RequestSendSystemUpdate]]/[[#RequestReceiveSystemUpdate]], besides HMAC validation.
| 3 || GetResult ||  
|-
|-
| 0xE0 || 0x20 || HMAC-SHA256 over the previous 0xE0-bytes.
| 100 || GetNetworkServiceLicenseInfoForOnlinePlay ||  
|}
|}


This is "nn::ns::SystemDeliveryInfo". This is a 0x100-byte struct.
= acc:u1 =
This is "nn::account::IAccountServiceForSystemService".
 
[13.0.0+] This was moved from [[Account_services|account]].
 
This is only available when the output from [[Process_Manager_services|pm:bm]] GetBootMode is Normal/Maintenance.


= ApplicationDeliveryInfo =
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset
! Cmd || Name || Notes
! Size
! Description
|-
|-
| 0x0 || 0x8 || ?
| 0 || GetUserCount ||
|-
|-
| 0x8 || 0x8 || ApplicationId.
| 1 || GetUserExistence ||
|-
|-
| 0x10 || 0x4 || ApplicationVersion.
| 2 || ListAllUsers ||
|-
|-
| 0x14 || 0x4 || ?
| 3 || ListOpenUsers ||
|-
|-
| 0x18 || 0x4 || RequiredSystemVersion.
| 4 || GetLastOpenedUser ||
|-
|-
| 0x1C || 0x4 || ?
| 5 || GetProfile || Returns an [[#IProfile]].
|-
|-
| 0x20 || 0xC0 || ?
| 6 || [3.0.0+] GetProfileDigest ||
|-
|-
| 0xE0 || 0x20 || HMAC-SHA256 over the previous 0xE0-bytes. Uses a different key than [[#SystemDeliveryInfo]].
| 50 || [[#IsUserRegistrationRequestPermitted]] ||
|}
 
This is "nn::ns::ApplicationDeliveryInfo". This is a 0x100-byte struct.
 
= LatestSystemUpdate =
{| class="wikitable" border="1"
|-
|-
!  Value
| 51 || TrySelectUserWithoutInteractionDeprecated ([1.0.0-18.1.0] [[#TrySelectUserWithoutInteraction]]) ||
!  Description
|-
|-
| 1 || Unknown.
| 52 || [19.0.0+] TrySelectUserWithoutInteraction ||
|-
|-
| 2 || Unknown.
| 60 || [5.0.0-5.1.0] ListOpenContextStoredUsers ||
|-
|-
| Other values || Unknown.
| 99 || [6.0.0+] DebugActivateOpenContextRetention || No input, returns an [[#ISessionObject]].
|}
 
This is "nn::ns::LatestSystemUpdate". This is an u8.
 
= ReceiveApplicationProgress =
This is "nn::ns::ReceiveApplicationProgress". This is a 0x10-byte struct.
 
= SendApplicationProgress =
This is "nn::ns::SendApplicationProgress". This is a 0x10-byte struct.
 
= ApplicationRightsOnClient =
This is a 0x20-byte struct.
 
[[qlaunch]] only uses +0x18/+0x19 in this struct.
 
{| class="wikitable" border="1"
|-
|-
! Offset
| 100 || GetUserRegistrationNotifier || Returns an [[#INotifier]].
! Size
! Description
|-
|-
| 0x0 || 0x8 || [[NCM_services#ApplicationId|ApplicationId]]
| 101 || GetUserStateChangeNotifier || Returns an [[#INotifier]].
|-
|-
| 0x8 || 0x10 || [[Account_services#Uid|Uid]]
| 102 || GetBaasAccountManagerForSystemService || Returns an [[#IManagerForSystemService]].
|-
| 103 || GetBaasUserAvailabilityChangeNotifier || Returns an [[#INotifier]].
|-
| 104 || GetProfileUpdateNotifier || Returns an [[#INotifier]].
|-
| 105 || [4.0.0+] CheckNetworkServiceAvailabilityAsync || Returns an [[#IAsyncContext]].
|-
| 106 || [9.0.0+] GetProfileSyncNotifier ||
|-
| 110 || StoreSaveDataThumbnail ||
|-
| 111 || ClearSaveDataThumbnail ||
|-
| 112 || LoadSaveDataThumbnail ||
|-
| 113 || [5.0.0+] GetSaveDataThumbnailExistence ||
|-
| 120 || [10.0.0+] ListOpenUsersInApplication ||
|-
| 130 || [6.0.0+] ActivateOpenContextRetention || Takes a total of 0x8-bytes of input, returns an [[#ISessionObject]].
|-
| 140 || [6.0.0+] ListQualifiedUsers ||
|-
|-
| 0x18 || 0x1 || Flags, [[qlaunch]] only uses bit0-bit4 and bit7.
| 150 || [10.0.0-10.2.0] AuthenticateApplicationAsync ||
|-
|-
| 0x19 || 0x1 || Flags, [[qlaunch]] only uses bit0.
| 151 || [12.0.0+] EnsureSignedDeviceIdentifierCacheForNintendoAccountAsync ||  
|-
|-
| 0x1A || 0x6 || Unknown
| 152 || [12.0.0+] LoadSignedDeviceIdentifierCacheForNintendoAccount ||
|}
 
= DownloadTaskStatus =
This is "nn::ns::DownloadTaskStatus". This is a 0x20-byte struct.
 
= ApplicationLaunchInfo =
This is a 0x40-byte struct.
 
{| class="wikitable" border="1"
|-
|-
! Offset
| 170 || [13.0.0+] GetNasOp2MembershipStateChangeNotifier ||
! Size
|-
! Description
| 190 || [1.0.0-9.2.0] GetUserLastOpenedApplication ||
|-
|-
| 0x0 || 0x8 || [[NCM_services#ApplicationId|ApplicationId]]
| 191 || [7.0.0-19.0.1] UpdateNotificationReceiverInfo ([5.0.0-5.1.0] ActivateOpenContextHolder) ||
|-
|-
| 0x8 || 0x4 || Application version
| 401 || [18.0.0+] GetPinCodeLength ||
|-
|-
| 0xC || 0x4 || [[Process_Manager_services#LaunchFlags|LaunchFlags]], set to hard-coded value 0xB by [[#GetApplicationLaunchInfo]].
| 402 || [18.0.0-19.0.1] GetPinCode ||
|-
|-
| 0x10 || 0x1 || Application [[NCM_services#StorageId|StorageId]]
| 403 || [20.0.0+] GetPinCodeParity ||
|-
|-
| 0x11 || 0x1 || Update [[NCM_services#StorageId|StorageId]]
| 404 || [20.0.0+] VerifyPinCode ||
|-
|-
| 0x12 || 0x2E ||  
| 405 || [20.0.0+] IsPinCodeVerificationForbidden ||
|}
|-
 
| 997 || [3.0.0+] DebugInvalidateTokenCacheForUser ||
= UserData =
|-
{| class="wikitable" border="1"
| 998 || DebugSetUserStateClose ||
|-
|-
! Offset || Size || Description
| 999 || DebugSetUserStateOpen ||
|-
|}
| 0x0 || 0x4? || ?
 
|-
[10.0.0+] DebugSetUserStateClose/DebugSetUserStateOpen now takes an additional 8-bytes of input.
| 0x4 || 0x4? || Icon ID. 0 = Mii, the rest are character icon IDs.
 
|-
== IOAuthProcedureForUserRegistration ==
| 0x8 || 0x1? || Profile icon background color ID
This is "nn::account::nas::IOAuthProcedureForUserRegistration".
|-
 
| 0x9 || 0x7 || ?
This was added with [8.0.0+].
|-
 
| 0x10 || 0x10 || Some ID related to the Mii? All zeros when a character icon is used.
{| class="wikitable" border="1"
|-
|-
| 0x20 || 0x60 || Usually zeros?
! Cmd || Name || Notes
|}
|-
 
| 0 || PrepareAsync || No input, returns an [[#IAsyncContext]].
This is a 0x80-byte struct.
|-
| 1 || GetRequest ||
|-
| 2 || ApplyResponse ||
|-
| 3 || ApplyResponseAsync || Takes a type-0x9 input buffer, returns an [[#IAsyncContext]].
|-
| 10 || Suspend ||
|-
| 100 || GetAccountId ||
|-
| 101 || GetLinkedNintendoAccountId ||
|-
| 102 || GetNickname ||
|-
| 103 || GetProfileImage ||
|-
| 104 || [18.0.0+] GetProfileLargeImage ||
|-
| 110 || RegisterUserAsync || No input, returns an [[#IAsyncContext]].
|-
| 111 || GetUid ||
|-
| 200 || [17.0.0+] ApplyResponseForUserCreationAsync ||
|-
| 205 || [17.0.0+] SuspendAfterApplyResponse ||
|-
| 210 || [17.0.0+] IsProfileAvailable ||
|-
| 220 || [17.0.0+] RegisterUserAsyncWithoutProfile ||
|-
| 221 || [17.0.0+] RegisterUserWithProfileAsync ||
|-
| 230 || [18.0.0+] RegisterUserWithLargeImageProfileAsync ||
|}
 
= ApplicationRecord =
This is "nn::ns::ApplicationRecord".
 
{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x8
| [[NCM_services#ApplicationId|Id]]
|-
| 0x8
| 0x1
| [[#ApplicationEvent|LastEvent]]
|-
| 0x9
| 0x1
| Attributes
|-
| 0xA
| 0x6
| Reserved
|-
| 0x10
| 0x8
| LastUpdated
|}
 
= ApplicationEvent =
This is "nn::ns::ApplicationEvent".
 
{| class="wikitable" border="1"
|-
! Value
! Description
|-
| 0 || Launched
|-
| 1 || LocalInstalled
|-
| 2 || DownloadStarted
|-
| 3 || GameCardInserted
|-
| 4 || Touched
|-
| 5 ||
|-
| 6 ||
|-
| 7 ||
|-
| 8 ||
|-
| 9 ||
|-
| 10 ||
|-
| 11 ||
|-
| 12 ||
|-
| 13 ||
|-
| 14 ||
|-
| 15 ||
|-
| 16 ||
|}
 
= ApplicationControlSource =
This is "nn::ns::ApplicationControlSource".
 
{| class="wikitable" border="1"
|-
! Value
! Description
|-
| 0
| CacheOnly
|-
| 1
| Storage
|-
| 2
| StorageOnly
|}
 
= ApplicationContentMetaStatus =
This is "nn::ns::ApplicationContentMetaStatus".
 
{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x1
| [[NCM_services#ContentMetaType|Type]]
|-
| 0x1
| 0x1
| [[NCM_services#StorageId|InstalledStorage]]
|-
| 0x2
| 0x1
| [[#ContentMetaRightsCheck|RightsCheck]]
|-
| 0x3
| 0x1
| Reserved
|-
| 0x4
| 0x4
| Version
|-
| 0x8
| 0x8
| [[NCM_services#ApplicationId|Id]]
|}
 
= ContentMetaRightsCheck =
This is "nn::ns::ContentMetaRightsCheck".
 
{| class="wikitable" border="1"
|-
! Value
! Description
|-
| 0
| NotChecked
|-
| 1
| NotNeeded
|-
| 2
| CommonRights
|-
| 3
| PersonalizedRights
|-
| 4
| NoRights
|}
 
= VersionListData =
This is "nn::ns::VersionListData".
 
= ApplicationUpdateInfo =
This is "nn::ns::ApplicationUpdateInfo".
 
{| class="wikitable" border="1"
|-
! Value
! Description
|-
| 0 || UpToDate
|-
| 1 || Updatable
|}
 
= ApplicationOccupiedSize =
This is "nn::ns::ApplicationOccupiedSize". This is a 0x80-byte struct.
 
{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0 || 0x20 * 4 || Array of [[#ApplicationOccupiedSizeEntity]]
|}
 
= ApplicationOccupiedSizeEntity =
This is "nn::ns::ApplicationOccupiedSizeEntity". This is a 0x20-byte struct.
 
{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0 || 0x1 || [[NCM_services#StorageId|StorageId]]
|-
| 0x1 || 0x7 || Reserved
|-
| 0x8 || 0x8 || AppSize
|-
| 0x10 || 0x8 || PatchSize
|-
| 0x18 || 0x8 || AocSize
|}
 
= ProgressForDeleteUserSaveDataAll =
This is "nn::ns::detail::ProgressForDeleteUserSaveDataAll". This is a 0x28-byte struct.
 
{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0 || 0x8 || StartedAt
|-
| 0x8 || 0x4 || Count
|-
| 0xC || 0x4 || Reserved
|-
| 0x10 || 0x8 || SizeInBytes
|-
| 0x18 || 0x1 || IsSystem
|-
| 0x19 || 0x7 || Reserved
|-
| 0x20 || 0x8 || ApplicationId
|}
 
= ApplicationViewDeprecated =
This is "nn::ns::ApplicationViewDeprecated". This is a 0x40-byte struct.
 
{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0 || 0x8 || [[NCM_services#ApplicationId|ApplicationId]]
|-
| 0x8 || 0x4 || Version
|-
| 0xC || 0x4 || [[#ApplicationViewFlag|Flag]]
|-
| 0x10 || 0x18 || [[#ApplicationDownloadProgress|Progress]]
|-
| 0x28 || 0x18 || [[#ApplicationApplyDeltaProgress|ApplyProgress]]
|}
 
This is converted from [[#ApplicationView]] by [[#GetApplicationViewDeprecated]] on newer system-versions as follows:
 
{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0 || 0x20 || Same as [[#ApplicationView]] +0x0.
|-
| 0x20 || 0x4 || Same as [[#ApplicationView]] +0x20.
|-
| 0x24 || 0x2 || Same as [[#ApplicationView]] +0x24.
|-
| 0x26 || 0x2 || Cleared to 0.
|-
| 0x28 || 0x10 || Same as [[#ApplicationView]] +0x30.
|-
| 0x38 || 0x4 || Same as [[#ApplicationView]] +0x40.
|-
| 0x3C || 0x1 || Same as [[#ApplicationView]] +0x44.
|-
| 0x3D || 0x2 || Cleared to 0.
|-
| 0x3F || 0x1 || Cleared to 0.
|}
 
= ApplicationViewFlag =
This is "nn::ns::ApplicationViewFlag". This is a 32-bit flag.
 
{| class="wikitable" border="1"
|-
! Bit
! Description
|-
| 0
|
|-
| 1
|
|-
| 2
|
|-
| 3
|
|-
| 4
|
|-
| 5
|
|-
| 6
|
|-
| 7
|
|-
| 8
|
|-
| 9
|
|-
| 10
|
|-
| 11
|
|-
| 12
|
|-
| 13
|
|-
| 14
|
|-
| 15
|
|-
| 16
|
|-
| 17
|
|}
 
= ApplicationDownloadProgress =
This is "nn::ns::ApplicationDownloadProgress". This is a 0x18-byte struct.
 
{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0 || 0x8 || Downloaded
|-
| 0x8 || 0x8 || Total
|-
| 0x10 || 0x4 || LastResult
|-
| 0x14 || 0x1 || [[#ApplicationDownloadState|State]]
|-
| 0x15 || 0x3 || Reserved
|}
 
= ApplicationApplyDeltaProgress =
This is "nn::ns::ApplicationApplyDeltaProgress". This is a 0x18-byte struct.
 
{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0 || 0x8 || Applied
|-
| 0x8 || 0x8 || Total
|-
| 0x10 || 0x4 || LastResult
|-
| 0x14 || 0x1 || [[#ApplicationApplyDeltaState|State]]
|-
| 0x15 || 0x3 || Reserved
|}
 
= ApplicationDownloadState =
This is "nn::ns::ApplicationDownloadState". This is an u8.
 
{| class="wikitable" border="1"
|-
! Value
! Description
|-
| 0 || Runnable
|-
| 1 || Suspended
|-
| 2 || NotEnoughSpace
|-
| 3 || Fatal
|-
| 4 || Finished
|}
 
= ApplicationApplyDeltaState =
This is "nn::ns::ApplicationApplyDeltaState". This is an u8.
 
{| class="wikitable" border="1"
|-
! Value
! Description
|-
| 0 || Applying
|-
| 1 || Suspended
|-
| 2 || NotEnoughSpace
|-
| 3 || Fatal
|-
| 4 || NoTask
|-
| 5 || WaitApply
|-
| 6 || Applied
|}
 
= ApplicationView =
This is "nn::ns::ApplicationView". This is a 0x50-byte struct.
 
{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0 || 0x8 || [[NCM_services#ApplicationId|ApplicationId]]
|-
| 0x8 || 0x4 || ?
|-
| 0xC || 0x4 || Flags
|-
| 0x10 || 0x40 || ?
|}
 
= ApplicationViewWithPromotionInfo =
This is a 0x70-byte struct.
 
[20.0.0+] This is a 0x78-byte struct.
 
{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0 || 0x50 || [[#ApplicationView]]
|-
| 0x50 || 0x20 || [[#PromotionInfo]]
|}
 
= PromotionInfo =
This is a 0x20-byte struct.
 
{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0 || 0x8 || PosixTime start_timestamp.
|-
| 0x8 || 0x8 || PosixTime end_timestamp.
|-
| 0x10 || 0x8 || Remaining time until the promotion ends, in nanoseconds ({end_timestamp - current_time} converted to nanoseconds).
|-
| 0x18 || 0x4 || Not set, left at zero.
|-
| 0x1C || 0x1 || Flags. Bit0: whether the PromotionInfo is valid (including bit1). Bit1 clear: u64 +0x10 is set.
|-
| 0x1D || 0x3 || Padding
|}
 
= ApplicationResourceType =
This is "nn::ns::ApplicationResourceType". This is an u8.
 
{| class="wikitable" border="1"
|-
! Value
! Description
|-
| 0 || ApplicationResource
|-
| 1 || MicroApplicationResource
|}
 
= ApplicationErrorCodeCategory =
This is "nn::ns::ApplicationErrorCodeCategory". This is an u64.
 
= NoDownloadRightsErrorResolution =
This is "nn::ns::NoDownloadRightsErrorResolution".
 
= BackgroundNetworkUpdateState =
This is "nn::ns::BackgroundNetworkUpdateState". This is an u8.
 
{| class="wikitable" border="1"
|-
! Value
! Description
|-
| 0 || None
|-
| 1 || InProgress
|-
| 2 || Ready
|}
 
Similar to [[#HasDownloaded]], [[#GetBackgroundNetworkUpdateState]] uses [[NIM_services|nim]] ListSystemUpdateTask and [[NIM_services|nim]] GetSystemUpdateTaskInfo. When ListSystemUpdateTask successfully returns a task and GetSystemUpdateTaskInfo is successful, the output value is set to: <code>1 + *((u8*)(taskinfo+0) == 0x3</code>. Otherwise, value=0.
 
[[#GetBackgroundNetworkUpdateState]] always returns Result 0, however this will assert if GetSystemUpdateTaskInfo fails with ret!=0x3C89.
 
= SystemUpdateProgress =
This is "nn::ns::SystemUpdateProgress". This is a 0x10-byte struct.
 
{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0 || 0x8 || Loaded (this value can be larger than total_size when the async operation is finishing and when total_size is <=0, this current_size field may contain a progress value for when the total_size is not yet determined)
|-
| 0x8 || 0x8 || Total (this field is only valid when >0)
|}
 
Commands which have this as output will return 0 with the output cleared, when no task is available.
 
= EulaDataPath =
This is "nn::ns::detail::EulaDataPath". This is a 0x100-byte struct.
 
This contains a file path.
 
= SystemDeliveryInfo =
This is "nn::ns::SystemDeliveryInfo". This is a 0x100-byte struct.
 
[20.0.0+] The used (New)SystemUpdateMetaId as selected by NewSystemUpdateMetaIdFlag must now match one of the Ids in [[System_Settings|system-setting]] <code>contents_delivery!acceptable_system_update_ids_string</code>.
 
{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0 || 0x4 || SystemDeliveryProtocolVersion. Must be <= to and match [[System_Settings|system-setting]] <code>contents_delivery!system_delivery_protocol_version</code>.
|-
| 0x4 || 0x4 || ApplicationDeliveryProtocolVersion. Loaded from [[System_Settings|system-setting]] <code>contents_delivery!application_delivery_protocol_version</code>. Unused by [[#RequestSendSystemUpdate]]/[[#RequestReceiveSystemUpdate]], besides HMAC validation.
|-
| 0x8 || 0x1 || HasExFat. Unused by [[#RequestSendSystemUpdate]]/[[#RequestReceiveSystemUpdate]], besides HMAC validation.
|-
| 0x9 || 0x3 || Reserved.
|-
| 0xC || 0x4 || SystemUpdateMetaVersion.
|-
| 0x10 || 0x8 || SystemUpdateMetaId.
|-
| 0x18 || 0x1 || FirmwareVariationId. Used by [[#RequestSendSystemUpdate]].
|-
| 0x19 || 0x1 || UpdatableFirmwareGroupId. Unused by [[#RequestSendSystemUpdate]]/[[#RequestReceiveSystemUpdate]], besides HMAC validation.
|-
| 0x1A || 0x1 || PlatformRegion (0x00 = Unknown, 0x01 = Global, 0x02 = China).
|-
| 0x1B || 0x1 || [20.0.0+] SystemDeliveryInfoPlatform. Loaded from [[System_Settings|system-setting]] <code>ns.systemupdate!system_delivery_info_platform</code>. Elsewhere this is compared against the sys-setting, etc.
|-
| 0x1C || 0x1 || [20.0.0+] NewSystemUpdateMetaIdFlag. When non-zero, NewSystemUpdateMetaId is used instead of SystemUpdateMetaId. Always set to 0x1 by [[#GetSystemDeliveryInfo]] with [20.0.0+].
|-
| 0x1D || 0x3 || Padding
|-
| 0x20 || 0x8 || [20.0.0+] NewSystemUpdateMetaId. See above. With [20.0.0+] [[#GetSystemDeliveryInfo]] now writes the Id here instead of SystemUpdateMetaId.
|-
| 0x28 || 0xB8 || Unused by [[#RequestSendSystemUpdate]]/[[#RequestReceiveSystemUpdate]], besides HMAC validation.
|-
| 0xE0 || 0x20 || HMAC-SHA256 over the previous 0xE0-bytes.
|}
 
= ApplicationDeliveryInfo =
This is "nn::ns::ApplicationDeliveryInfo". This is a 0x100-byte struct.
 
{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0 || 0x8 || ?
|-
| 0x8 || 0x8 || ApplicationId.
|-
| 0x10 || 0x4 || ApplicationVersion.
|-
| 0x14 || 0x4 || ?
|-
| 0x18 || 0x4 || RequiredSystemVersion.
|-
| 0x1C || 0x4 || ?
|-
| 0x20 || 0xC0 || ?
|-
| 0xE0 || 0x20 || HMAC-SHA256 over the previous 0xE0-bytes. Uses a different key than [[#SystemDeliveryInfo]].
|}
 
= LatestSystemUpdate =
This is "nn::ns::LatestSystemUpdate". This is an u8.
 
{| class="wikitable" border="1"
|-
! Value
! Description
|-
| 0 || UpToDate
|-
| 1 || Downloaded
|-
| 2 || NeedsDownload
|}
 
= ReceiveApplicationProgress =
This is "nn::ns::ReceiveApplicationProgress". This is a 0x10-byte struct.
 
= SendApplicationProgress =
This is "nn::ns::SendApplicationProgress". This is a 0x10-byte struct.
 
= ApplicationRightsOnClient =
This is a 0x20-byte struct.
 
{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0 || 0x8 || [[NCM_services#ApplicationId|ApplicationId]]
|-
| 0x8 || 0x10 || [[Account_services#Uid|Uid]]
|-
| 0x18 || 0x1 || Flags, [[qlaunch]] only uses bit0-bit4 and bit7.
|-
| 0x19 || 0x1 || Flags, [[qlaunch]] only uses bit0.
|-
| 0x1A || 0x6 || Unknown
|}
 
[[qlaunch]] only uses +0x18/+0x19 in this struct.
 
= DownloadTaskStatus =
This is "nn::ns::DownloadTaskStatus". This is a 0x20-byte struct.
 
{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0 || 0x10 || Uuid
|-
| 0x10 || 0x8 || [[NCM_services#ApplicationId|ApplicationId]]
|-
| 0x18 || 0x1 || [[#DownloadTaskStatusDetail|Detail]]
|-
| 0x19 || 0x1 || NeedsCleanup
|-
| 0x1A || 0x2 || Reserved
|-
| 0x1C || 0x4 || Result
|}
 
= DownloadTaskStatusDetail =
This is "nn::ns::DownloadTaskStatusDetail". This is an u8.
 
{| class="wikitable" border="1"
|-
! Value
! Description
|-
| 0 || Created
|-
| 1 || Added
|-
| 2 || AlreadyExists
|-
| 3 || Failed
|}
 
= ApplicationLaunchInfo =
This is a 0x40-byte struct.
 
{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0 || 0x8 || [[NCM_services#ApplicationId|ApplicationId]]
|-
| 0x8 || 0x4 || Application version
|-
| 0xC || 0x4 || [[Process_Manager_services#LaunchFlags|LaunchFlags]], set to hard-coded value 0xB by [[#GetApplicationLaunchInfo]].
|-
| 0x10 || 0x1 || Application [[NCM_services#StorageId|StorageId]]
|-
| 0x11 || 0x1 || Update [[NCM_services#StorageId|StorageId]]
|-
| 0x12 || 0x2E ||  
|}
 
= UserData =
This is a 0x80-byte struct.
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x4? || ?
|-
| 0x4 || 0x4? || Icon ID. 0 = Mii, the rest are character icon IDs.
|-
| 0x8 || 0x1? || Profile icon background color ID
|-
| 0x9 || 0x7 || ?
|-
| 0x10 || 0x10 || Some ID related to the Mii? All zeros when a character icon is used.
|-
| 0x20 || 0x60 || Usually zeros?
|}
 
= ProfileBase =
This is a 0x38-byte struct.


= ProfileBase =
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 3,685: Line 4,622:
|-
|-
| 0x18 || 0x20 || UTF-8 Nickname. Official sw uses strncpy to copy this into another struct (<code>nn::account::Nickname</code>), with a NUL-byte written after the copied data.
| 0x18 || 0x20 || UTF-8 Nickname. Official sw uses strncpy to copy this into another struct (<code>nn::account::Nickname</code>), with a NUL-byte written after the copied data.
|-
|}
|}
This is a 0x38-byte struct.


= Uid =
= Uid =
Line 3,702: Line 4,636:
* Initializes [[ETicket_services|es]] and [[Shared_Database_services|avm]] only for BootMode Normal/Maintenance.
* Initializes [[ETicket_services|es]] and [[Shared_Database_services|avm]] only for BootMode Normal/Maintenance.


The output of GetBootMode is also written into state. This same func later enters a code block when BootMode is Maintenance/SafeMode: various [[NCM_services|ncm]] cmds are used with input StorageId=BuiltInUser (VerifyContentMetaDatabase, VerifyContentStorage, ActivateContentMetaDatabase, ActivateContentStorage, InactivateContentMetaDatabase, InactivateContentStorage) and state fields are written. Then if the BootMode is Maintenance the savedata for [[Flash_Filesystem|ns_rightsid]] (0x800000000000004A) is deleted. Then 0 is returned.
The output of GetBootMode is also written into state. This same func later enters a code block when BootMode is Maintenance/SafeMode: various [[NCM_services|ncm]] cmds are used with input StorageId=BuiltInUser (VerifyContentMetaDatabase, VerifyContentStorage, ActivateContentMetaDatabase, ActivateContentStorage, InactivateContentMetaDatabase, InactivateContentStorage) and state fields are written. Then if the BootMode is Maintenance the savedata for [[Flash_Filesystem|ns_rightsid]] (0x800000000000004A) is deleted. Then 0 is returned. Otherwise for BootMode Normal it continues with various initialization, including gamecard handling which handles launching the gamecard title in certain conditions (this is the only time ns launches anything with pgl outside of service cmds).


In the above block, InactivateContentMetaDatabase/InactivateContentStorage are only used if using ActivateContentMetaDatabase/ActivateContentStorage failed (error is only checked after using both cmds). If any of the ncm cmds prior to this fail, it will skip using the rest of the ncm cmds.
In the above block, InactivateContentMetaDatabase/InactivateContentStorage are only used if using ActivateContentMetaDatabase/ActivateContentStorage failed (error is only checked after using both cmds). If any of the ncm cmds prior to this fail, it will skip using the rest of the ncm cmds.


[[Category:Services]]
[[Category:Services]]
Retrieved from "https://switchbrew.org/wiki/NS_services"