ns.h File Reference

NS services IPC wrapper. More...

#include "../types.h"
#include "../nacp.h"
#include "../sf/service.h"
#include "../services/ncm_types.h"
#include "../services/async.h"
#include "../services/acc.h"
#include "../services/fs.h"
#include "../applets/error.h"
#include "../kernel/event.h"
#include "../kernel/tmem.h"

Go to the source code of this file.

Data Structures
struct	NsRequestServerStopper
	RequestServerStopper. More...
struct	NsProgressMonitorForDeleteUserSaveDataAll
	ProgressMonitorForDeleteUserSaveDataAll. More...
struct	NsProgressAsyncResult
	ProgressAsyncResult. More...
struct	NsSystemUpdateControl
	SystemUpdateControl. More...
struct	NsApplicationControlData
	ApplicationControlData. More...
struct	NsApplicationOccupiedSize
	ApplicationOccupiedSize. More...
struct	NsApplicationContentMetaStatus
	NsApplicationContentMetaStatus. More...
struct	NsApplicationRecord
	ApplicationRecord. More...
struct	NsProgressForDeleteUserSaveDataAll
	ProgressForDeleteUserSaveDataAll. More...
struct	NsApplicationViewDeprecated
	ApplicationViewDeprecated. The below comments are for the NsApplicationView to NsApplicationViewDeprecated conversion done by nsGetApplicationViewDeprecated on newer system-versions. More...
struct	NsApplicationView
	ApplicationView. More...
struct	NsPromotionInfo
	NsPromotionInfo. More...
struct	NsApplicationViewWithPromotionInfo
	NsApplicationViewWithPromotionInfo. More...
struct	NsLaunchProperties
	LaunchProperties. More...
struct	NsShellEventInfo
	ShellEventInfo. More...
struct	NsSystemUpdateProgress
	SystemUpdateProgress. Commands which have this as output will return 0 with the output cleared, when no task is available. More...
struct	NsEulaDataPath
	EulaDataPath. More...
struct	NsSystemDeliveryInfo
	SystemDeliveryInfo. More...
struct	NsApplicationDeliveryInfo
	ApplicationDeliveryInfo. More...
struct	NsApplicationRightsOnClient
	NsApplicationRightsOnClient. More...
struct	NsDownloadTaskStatus
	DownloadTaskStatus. More...

Macros
#define	NSSU_CARDUPDATE_TMEM_SIZE_DEFAULT   0x100000
	Default size for nssuControlSetupCardUpdate / nssuControlSetupCardUpdateViaSystemUpdater. This is the size used by qlaunch for SetupCardUpdate.

Typedefs
typedef NsSystemUpdateProgress	NsReceiveApplicationProgress
	ReceiveApplicationProgress. Same as NsSystemUpdateProgress, except cmds which return this will return actual errors on failure, instead of returning 0 with a cleared struct.
typedef NsSystemUpdateProgress	NsSendApplicationProgress
	SendApplicationProgress. Same as NsSystemUpdateProgress, except cmds which return this will return actual errors on failure, instead of returning 0 with a cleared struct.

Enumerations
enum	NsShellEvent {   NsShellEvent_None = 0 ,   NsShellEvent_Exit = 1 ,   NsShellEvent_Start = 2 ,   NsShellEvent_Crash = 3 ,   NsShellEvent_Debug = 4 }
	ShellEvent. More...
enum	NsApplicationControlSource {   NsApplicationControlSource_CacheOnly = 0 ,   NsApplicationControlSource_Storage = 1 ,   NsApplicationControlSource_StorageOnly = 2 }
	ApplicationControlSource. More...
enum	NsBackgroundNetworkUpdateState {   NsBackgroundNetworkUpdateState_None = 0 ,   NsBackgroundNetworkUpdateState_Downloading = 1 ,   NsBackgroundNetworkUpdateState_Ready = 2 }
	BackgroundNetworkUpdateState. More...
enum	NsLatestSystemUpdate {   NsLatestSystemUpdate_Unknown0 = 0 ,   NsLatestSystemUpdate_Unknown1 = 1 ,   NsLatestSystemUpdate_Unknown2 = 2 }
	LatestSystemUpdate. More...

Functions
ns
Result	nsInitialize (void)
	Initialize ns services. Uses ns:am on pre-3.0.0, ns:am2 on [3.0.0+].
void	nsExit (void)
	Exit ns services.
Service *	nsGetServiceSession_GetterInterface (void)
	Gets the Service object for the actual ns:* service session. Only initialized on [3.0.0+], on pre-3.0.0 see nsGetServiceSession_ApplicationManagerInterface.
Service *	nsGetServiceSession_ApplicationManagerInterface (void)
	Gets the Service object for IApplicationManagerInterface. Only initialized on pre-3.0.0, on [3.0.0+] use nsGetApplicationManagerInterface.
Result	nsGetDynamicRightsInterface (Service *srv_out)
	Gets the Service object for IDynamicRightsInterface via the cmd for that.
Result	nsGetReadOnlyApplicationControlDataInterface (Service *srv_out)
	Gets the Service object for IReadOnlyApplicationControlDataInterface via the cmd for that.
Result	nsGetReadOnlyApplicationRecordInterface (Service *srv_out)
	Gets the Service object for IReadOnlyApplicationRecordInterface via the cmd for that.
Result	nsGetECommerceInterface (Service *srv_out)
	Gets the Service object for IECommerceInterface via the cmd for that.
Result	nsGetApplicationVersionInterface (Service *srv_out)
	Gets the Service object for IApplicationVersionInterface via the cmd for that.
Result	nsGetFactoryResetInterface (Service *srv_out)
	Gets the Service object for IFactoryResetInterface via the cmd for that.
Result	nsGetAccountProxyInterface (Service *srv_out)
	Gets the Service object for IAccountProxyInterface via the cmd for that.
Result	nsGetApplicationManagerInterface (Service *srv_out)
	Gets the Service object for IApplicationManagerInterface via the cmd for that.
Result	nsGetDownloadTaskInterface (Service *srv_out)
	Gets the Service object for IDownloadTaskInterface via the cmd for that.
Result	nsGetContentManagementInterface (Service *srv_out)
	Gets the Service object for IContentManagementInterface via the cmd for that.
Result	nsGetDocumentInterface (Service *srv_out)
	Gets the Service object for IDocumentInterface via the cmd for that.
IReadOnlyApplicationControlDataInterface
Result	nsGetApplicationControlData (NsApplicationControlSource source, u64 application_id, NsApplicationControlData *buffer, size_t size, u64 *actual_size)
	Gets the NsApplicationControlData for the specified application.
Result	nsGetApplicationDesiredLanguage (NacpStruct *nacp, NacpLanguageEntry **langentry)
	GetApplicationDesiredLanguage.
IECommerceInterface
Result	nsRequestLinkDevice (AsyncResult *a, AccountUid uid)
	RequestLinkDevice.
Result	nsRequestSyncRights (AsyncResult *a)
	RequestSyncRights.
Result	nsRequestUnlinkDevice (AsyncResult *a, AccountUid uid)
	RequestUnlinkDevice.
IFactoryResetInterface
Result	nsResetToFactorySettings (void)
	ResetToFactorySettings.
Result	nsResetToFactorySettingsWithoutUserSaveData (void)
	ResetToFactorySettingsWithoutUserSaveData.
Result	nsResetToFactorySettingsForRefurbishment (void)
	ResetToFactorySettingsForRefurbishment.
Result	nsResetToFactorySettingsWithPlatformRegion (void)
	ResetToFactorySettingsWithPlatformRegion.
Result	nsResetToFactorySettingsWithPlatformRegionAuthentication (void)
	ResetToFactorySettingsWithPlatformRegionAuthentication.
IApplicationManagerInterface
Result	nsListApplicationRecord (NsApplicationRecord *records, s32 count, s32 entry_offset, s32 *out_entrycount)
	Gets an listing of NsApplicationRecord.
Result	nsGetApplicationRecordUpdateSystemEvent (Event *out_event)
	GetApplicationRecordUpdateSystemEvent.
Result	nsGetApplicationViewDeprecated (NsApplicationViewDeprecated *views, const u64 *application_ids, s32 count)
	GetApplicationViewDeprecated.
Result	nsDeleteApplicationEntity (u64 application_id)
	DeleteApplicationEntity.
Result	nsDeleteApplicationCompletely (u64 application_id)
	DeleteApplicationCompletely.
Result	nsDeleteRedundantApplicationEntity (void)
	DeleteRedundantApplicationEntity.
Result	nsIsApplicationEntityMovable (u64 application_id, NcmStorageId storage_id, bool *out)
	IsApplicationEntityMovable.
Result	nsMoveApplicationEntity (u64 application_id, NcmStorageId storage_id)
	MoveApplicationEntity.
Result	nsRequestApplicationUpdateInfo (AsyncValue *a, u64 application_id)
	RequestApplicationUpdateInfo.
Result	nsCancelApplicationDownload (u64 application_id)
	CancelApplicationDownload.
Result	nsResumeApplicationDownload (u64 application_id)
	ResumeApplicationDownload.
Result	nsCheckApplicationLaunchVersion (u64 application_id)
	CheckApplicationLaunchVersion.
Result	nsCalculateApplicationDownloadRequiredSize (u64 application_id, NcmStorageId *storage_id, s64 *size)
	CalculateApplicationApplyDeltaRequiredSize.
Result	nsCleanupSdCard (void)
	CleanupSdCard.
Result	nsGetSdCardMountStatusChangedEvent (Event *out_event)
	GetSdCardMountStatusChangedEvent.
Result	nsGetGameCardUpdateDetectionEvent (Event *out_event)
	GetGameCardUpdateDetectionEvent.
Result	nsDisableApplicationAutoDelete (u64 application_id)
	DisableApplicationAutoDelete.
Result	nsEnableApplicationAutoDelete (u64 application_id)
	EnableApplicationAutoDelete.
Result	nsSetApplicationTerminateResult (u64 application_id, Result res)
	SetApplicationTerminateResult.
Result	nsClearApplicationTerminateResult (u64 application_id)
	ClearApplicationTerminateResult.
Result	nsGetLastSdCardMountUnexpectedResult (void)
	GetLastSdCardMountUnexpectedResult.
Result	nsGetRequestServerStopper (NsRequestServerStopper *r)
	Opens a NsRequestServerStopper.
Result	nsCancelApplicationApplyDelta (u64 application_id)
	CancelApplicationApplyDelta.
Result	nsResumeApplicationApplyDelta (u64 application_id)
	ResumeApplicationApplyDelta.
Result	nsCalculateApplicationApplyDeltaRequiredSize (u64 application_id, NcmStorageId *storage_id, s64 *size)
	CalculateApplicationApplyDeltaRequiredSize.
Result	nsResumeAll (void)
	ResumeAll.
Result	nsGetStorageSize (NcmStorageId storage_id, s64 *total_space_size, s64 *free_space_size)
	Temporarily mounts the specified fs ContentStorage, then uses fs GetTotalSpaceSize/GetFreeSpaceSize with that mounted ContentStorage.
Result	nsRequestUpdateApplication2 (AsyncResult *a, u64 application_id)
	RequestUpdateApplication2.
Result	nsDeleteUserSaveDataAll (NsProgressMonitorForDeleteUserSaveDataAll *p, AccountUid uid)
	DeleteUserSaveDataAll.
Result	nsDeleteUserSystemSaveData (AccountUid uid, u64 system_save_data_id)
	DeleteUserSystemSaveData.
Result	nsDeleteSaveData (FsSaveDataSpaceId save_data_space_id, u64 save_data_id)
	DeleteSaveData.
Result	nsUnregisterNetworkServiceAccount (AccountUid uid)
	UnregisterNetworkServiceAccount.
Result	nsUnregisterNetworkServiceAccountWithUserSaveDataDeletion (AccountUid uid)
	UnregisterNetworkServiceAccountWithUserSaveDataDeletion.
Result	nsRequestDownloadApplicationControlData (AsyncResult *a, u64 application_id)
	RequestDownloadApplicationControlData.
Result	nsListApplicationTitle (AsyncValue *a, NsApplicationControlSource source, const u64 *application_ids, s32 count, void *buffer, size_t size)
	ListApplicationTitle.
Result	nsListApplicationIcon (AsyncValue *a, NsApplicationControlSource source, const u64 *application_ids, s32 count, void *buffer, size_t size)
	ListApplicationIcon.
Result	nsRequestCheckGameCardRegistration (AsyncResult *a, u64 application_id)
	RequestCheckGameCardRegistration.
Result	nsRequestGameCardRegistrationGoldPoint (AsyncValue *a, AccountUid uid, u64 application_id)
	RequestGameCardRegistrationGoldPoint.
Result	nsRequestRegisterGameCard (AsyncResult *a, AccountUid uid, u64 application_id, s32 inval)
	RequestRegisterGameCard.
Result	nsGetGameCardMountFailureEvent (Event *out_event)
	GetGameCardMountFailureEvent.
Result	nsIsGameCardInserted (bool *out)
	IsGameCardInserted.
Result	nsEnsureGameCardAccess (void)
	EnsureGameCardAccess.
Result	nsGetLastGameCardMountFailureResult (void)
	GetLastGameCardMountFailureResult.
Result	nsListApplicationIdOnGameCard (u64 *application_ids, s32 count, s32 *total_out)
	ListApplicationIdOnGameCard.
Result	nsTouchApplication (u64 application_id)
	TouchApplication.
Result	nsIsApplicationUpdateRequested (u64 application_id, bool *flag, u32 *out)
	IsApplicationUpdateRequested.
Result	nsWithdrawApplicationUpdateRequest (u64 application_id)
	WithdrawApplicationUpdateRequest.
Result	nsRequestVerifyAddOnContentsRights (NsProgressAsyncResult *a, u64 application_id)
	RequestVerifyAddOnContentsRights.
Result	nsRequestVerifyApplication (NsProgressAsyncResult *a, u64 application_id, u32 unk, void *buffer, size_t size)
	RequestVerifyApplication.
Result	nsIsAnyApplicationEntityInstalled (u64 application_id, bool *out)
	IsAnyApplicationEntityInstalled.
Result	nsCleanupUnavailableAddOnContents (u64 application_id, AccountUid uid)
	CleanupUnavailableAddOnContents.
Result	nsEstimateSizeToMove (u8 *storage_ids, s32 count, NcmStorageId storage_id, u32 flags, u64 application_id, s64 *out)
	EstimateSizeToMove.
Result	nsFormatSdCard (void)
	FormatSdCard.
Result	nsNeedsSystemUpdateToFormatSdCard (bool *out)
	NeedsSystemUpdateToFormatSdCard.
Result	nsGetLastSdCardFormatUnexpectedResult (void)
	GetLastSdCardFormatUnexpectedResult.
Result	nsGetApplicationView (NsApplicationView *views, const u64 *application_ids, s32 count)
	GetApplicationView.
Result	nsGetApplicationViewDownloadErrorContext (u64 application_id, ErrorContext *context)
	GetApplicationViewDownloadErrorContext.
Result	nsGetApplicationViewWithPromotionInfo (NsApplicationViewWithPromotionInfo *out, const u64 *application_ids, s32 count)
	GetApplicationViewWithPromotionInfo.
Result	nsRequestDownloadApplicationPrepurchasedRights (AsyncResult *a, u64 application_id)
	RequestDownloadApplicationPrepurchasedRights.
Result	nsGetSystemDeliveryInfo (NsSystemDeliveryInfo *info)
	Generates a NsSystemDeliveryInfo using the currently installed SystemUpdate meta.
Result	nsSelectLatestSystemDeliveryInfo (const NsSystemDeliveryInfo *sys_list, s32 sys_count, const NsSystemDeliveryInfo *base_info, const NsApplicationDeliveryInfo *app_list, s32 app_count, s32 *index)
	SelectLatestSystemDeliveryInfo.
Result	nsVerifyDeliveryProtocolVersion (const NsSystemDeliveryInfo *info)
	VerifyDeliveryProtocolVersion.
Result	nsGetApplicationDeliveryInfo (NsApplicationDeliveryInfo *info, s32 count, u64 application_id, u32 attr, s32 *total_out)
	Generates NsApplicationDeliveryInfo for the specified ApplicationId.
Result	nsHasAllContentsToDeliver (const NsApplicationDeliveryInfo *info, s32 count, bool *out)
	HasAllContentsToDeliver.
Result	nsCompareApplicationDeliveryInfo (const NsApplicationDeliveryInfo *info0, s32 count0, const NsApplicationDeliveryInfo *info1, s32 count1, s32 *out)
	Both NsApplicationDeliveryInfo are validated, then the application_version in the first/second NsApplicationDeliveryInfo are compared.
Result	nsCanDeliverApplication (const NsApplicationDeliveryInfo *info0, s32 count0, const NsApplicationDeliveryInfo *info1, s32 count1, bool *out)
	CanDeliverApplication.
Result	nsListContentMetaKeyToDeliverApplication (NcmContentMetaKey *meta, s32 meta_count, s32 meta_index, const NsApplicationDeliveryInfo *info, s32 info_count, s32 *total_out)
	ListContentMetaKeyToDeliverApplication.
Result	nsNeedsSystemUpdateToDeliverApplication (const NsApplicationDeliveryInfo *info, s32 count, const NsSystemDeliveryInfo *sys_info, bool *out)
	After validation etc, this sets the output bool by comparing system-version fields in the NsSystemDeliveryInfo / info-array and with a state field.
Result	nsEstimateRequiredSize (const NcmContentMetaKey *meta, s32 count, s64 *out)
	EstimateRequiredSize.
Result	nsRequestReceiveApplication (AsyncResult *a, u32 addr, u16 port, u64 application_id, const NcmContentMetaKey *meta, s32 count, NcmStorageId storage_id)
	RequestReceiveApplication.
Result	nsCommitReceiveApplication (u64 application_id)
	CommitReceiveApplication.
Result	nsGetReceiveApplicationProgress (u64 application_id, NsReceiveApplicationProgress *out)
	GetReceiveApplicationProgress.
Result	nsRequestSendApplication (AsyncResult *a, u32 addr, u16 port, u64 application_id, const NcmContentMetaKey *meta, s32 count)
	RequestSendApplication.
Result	nsGetSendApplicationProgress (u64 application_id, NsSendApplicationProgress *out)
	GetSendApplicationProgress.
Result	nsCompareSystemDeliveryInfo (const NsSystemDeliveryInfo *info0, const NsSystemDeliveryInfo *info1, s32 *out)
	Both NsSystemDeliveryInfo are validated, then the system_update_meta_version in the first/second NsSystemDeliveryInfo are compared.
Result	nsListNotCommittedContentMeta (NcmContentMetaKey *meta, s32 count, u64 application_id, s32 unk, s32 *total_out)
	ListNotCommittedContentMeta.
Result	nsGetApplicationDeliveryInfoHash (const NsApplicationDeliveryInfo *info, s32 count, u8 *out_hash)
	This extracts data from the input array for hashing with SHA256, with validation being done when handling each entry.
Result	nsGetApplicationTerminateResult (u64 application_id, Result *res)
	GetApplicationTerminateResult.
Result	nsGetApplicationRightsOnClient (NsApplicationRightsOnClient *rights, s32 count, u64 application_id, AccountUid uid, u32 flags, s32 *total_out)
	GetApplicationRightsOnClient.
Result	nsRequestNoDownloadRightsErrorResolution (AsyncValue *a, u64 application_id)
	RequestNoDownloadRightsErrorResolution.
Result	nsRequestResolveNoDownloadRightsError (AsyncValue *a, u64 application_id)
	RequestResolveNoDownloadRightsError.
Result	nsGetPromotionInfo (NsPromotionInfo *promotion, u64 application_id, AccountUid uid)
	GetPromotionInfo.
IDownloadTaskInterface
Result	nsClearTaskStatusList (void)
	ClearTaskStatusList.
Result	nsRequestDownloadTaskList (void)
	RequestDownloadTaskList.
Result	nsRequestEnsureDownloadTask (AsyncResult *a)
	RequestEnsureDownloadTask.
Result	nsListDownloadTaskStatus (NsDownloadTaskStatus *tasks, s32 count, s32 *total_out)
	ListDownloadTaskStatus.
Result	nsRequestDownloadTaskListData (AsyncValue *a)
	RequestDownloadTaskListData.
Result	nsTryCommitCurrentApplicationDownloadTask (void)
	TryCommitCurrentApplicationDownloadTask.
Result	nsEnableAutoCommit (void)
	EnableAutoCommit.
Result	nsDisableAutoCommit (void)
	DisableAutoCommit.
Result	nsTriggerDynamicCommitEvent (void)
	TriggerDynamicCommitEvent.
IContentManagementInterface
Result	nsCalculateApplicationOccupiedSize (u64 application_id, NsApplicationOccupiedSize *out)
	CalculateApplicationOccupiedSize.
Result	nsCheckSdCardMountStatus (void)
	CheckSdCardMountStatus.
Result	nsGetTotalSpaceSize (NcmStorageId storage_id, s64 *size)
	Returns the total storage capacity (used + free) from content manager services.
Result	nsGetFreeSpaceSize (NcmStorageId storage_id, s64 *size)
	Returns the available storage capacity from content manager services.
Result	nsCountApplicationContentMeta (u64 application_id, s32 *out)
	CountApplicationContentMeta.
Result	nsListApplicationContentMetaStatus (u64 application_id, s32 index, NsApplicationContentMetaStatus *list, s32 count, s32 *out_entrycount)
	Gets an listing of NsApplicationContentMetaStatus.
Result	nsIsAnyApplicationRunning (bool *out)
	IsAnyApplicationRunning.
IRequestServerStopper
void	nsRequestServerStopperClose (NsRequestServerStopper *r)
	Close a NsRequestServerStopper.
IProgressMonitorForDeleteUserSaveDataAll
Result	nsProgressMonitorForDeleteUserSaveDataAllClose (NsProgressMonitorForDeleteUserSaveDataAll *p)
	Close a NsProgressMonitorForDeleteUserSaveDataAll.
Result	nsProgressMonitorForDeleteUserSaveDataAllGetSystemEvent (NsProgressMonitorForDeleteUserSaveDataAll *p, Event *out_event)
	GetSystemEvent.
Result	nsProgressMonitorForDeleteUserSaveDataAllIsFinished (NsProgressMonitorForDeleteUserSaveDataAll *p, bool *out)
	IsFinished.
Result	nsProgressMonitorForDeleteUserSaveDataAllGetResult (NsProgressMonitorForDeleteUserSaveDataAll *p)
	GetResult.
Result	nsProgressMonitorForDeleteUserSaveDataAllGetProgress (NsProgressMonitorForDeleteUserSaveDataAll *p, NsProgressForDeleteUserSaveDataAll *progress)
	GetProgress.
IProgressAsyncResult
void	nsProgressAsyncResultClose (NsProgressAsyncResult *a)
	Close a NsProgressAsyncResult.
Result	nsProgressAsyncResultWait (NsProgressAsyncResult *a, u64 timeout)
	Waits for the async operation to finish using the specified timeout.
Result	nsProgressAsyncResultGet (NsProgressAsyncResult *a)
	Gets the Result.
Result	nsProgressAsyncResultCancel (NsProgressAsyncResult *a)
	Cancels the async operation.
Result	nsProgressAsyncResultGetProgress (NsProgressAsyncResult *a, void *buffer, size_t size)
	Gets the progress.
Result	nsProgressAsyncResultGetDetailResult (NsProgressAsyncResult *a)
	GetDetailResult.
Result	nsProgressAsyncResultGetErrorContext (NsProgressAsyncResult *a, ErrorContext *context)
	Gets the ErrorContext.
ns:vm
Result	nsvmInitialize (void)
	Initialize ns:vm. On pre-3.0.0 this must be used with nsInitialize.
void	nsvmExit (void)
	Exit ns:vm.
Service *	nsvmGetServiceSession (void)
	Gets the Service object for ns:vm. This is only initialized on [3.0.0+].
Result	nsvmNeedsUpdateVulnerability (bool *out)
Result	nsvmGetSafeSystemVersion (NcmContentMetaKey *out)
	[4.0.0+]
ns:dev
Result	nsdevInitialize (void)
	Initialize ns:dev.
void	nsdevExit (void)
	Initialize ns:dev.
Service *	nsdevGetServiceSession (void)
	Gets the Service object for ns:dev.
Result	nsdevLaunchProgram (u64 *out_pid, const NsLaunchProperties *properties, u32 flags)
	[1.0.0-9.2.0]
Result	nsdevTerminateProcess (u64 pid)
Result	nsdevTerminateProgram (u64 tid)
	[1.0.0-9.2.0]
Result	nsdevGetShellEvent (Event *out_event)
	Autoclear for nsdevShellEvent is always true. [1.0.0-9.2.0].
Result	nsdevGetShellEventInfo (NsShellEventInfo *out)
	[1.0.0-9.2.0]
Result	nsdevTerminateApplication (void)
Result	nsdevPrepareLaunchProgramFromHost (NsLaunchProperties *out, const char *path, size_t path_len)
	[1.0.0-9.2.0]
Result	nsdevLaunchApplicationForDevelop (u64 *out_pid, u64 application_id, u32 flags)
	[1.0.0-9.2.0]
Result	nsdevLaunchApplicationFromHost (u64 *out_pid, const char *path, size_t path_len, u32 flags)
	[10.0.0-17.0.1]
Result	nsdevLaunchApplicationWithStorageIdForDevelop (u64 *out_pid, u64 application_id, u32 flags, u8 app_storage_id, u8 patch_storage_id)
	[1.0.0-17.0.1]
Result	nsdevIsSystemMemoryResourceLimitBoosted (bool *out)
	[6.0.0-8.1.0]
Result	nsdevGetRunningApplicationProcessIdForDevelop (u64 *out_pid)
	[6.0.0+]
Result	nsdevSetCurrentApplicationRightsEnvironmentCanBeActiveForDevelop (bool can_be_active)
	[6.0.0+]
ns:su
Result	nssuInitialize (void)
	Initialize ns:su.
void	nssuExit (void)
	Exit ns:su.
Service *	nssuGetServiceSession (void)
	Gets the Service object for ns:su.
Result	nssuGetBackgroundNetworkUpdateState (NsBackgroundNetworkUpdateState *out)
	Gets the NsBackgroundNetworkUpdateState.
Result	nssuOpenSystemUpdateControl (NsSystemUpdateControl *c)
	Opens a NsSystemUpdateControl.
Result	nssuNotifyExFatDriverRequired (void)
	Uses nim ListSystemUpdateTask, then uses the task with DestroySystemUpdateTask if it exists.
Result	nssuClearExFatDriverStatusForDebug (void)
	ClearExFatDriverStatusForDebug.
Result	nssuRequestBackgroundNetworkUpdate (void)
	RequestBackgroundNetworkUpdate.
Result	nssuNotifyBackgroundNetworkUpdate (const NcmContentMetaKey *key)
	This checks whether a sysupdate is needed with the input NcmContentMetaKey using NCM commands, if not this will just return 0.
Result	nssuNotifyExFatDriverDownloadedForDebug (void)
	NotifyExFatDriverDownloadedForDebug.
Result	nssuGetSystemUpdateNotificationEventForContentDelivery (Event *out_event)
	Gets an Event which can be signaled by nssuNotifySystemUpdateForContentDelivery.
Result	nssuNotifySystemUpdateForContentDelivery (void)
	Signals the event returned by nssuGetSystemUpdateNotificationEventForContentDelivery.
Result	nssuPrepareShutdown (void)
	This does shutdown preparation.
Result	nssuDestroySystemUpdateTask (void)
	This uses nim ListSystemUpdateTask, then when a task is returned uses it with DestroySystemUpdateTask.
Result	nssuRequestSendSystemUpdate (AsyncResult *a, u32 addr, u16 port, NsSystemDeliveryInfo *info)
	RequestSendSystemUpdate.
Result	nssuGetSendSystemUpdateProgress (NsSystemUpdateProgress *out)
	GetSendSystemUpdateProgress.
ISystemUpdateControl
void	nssuControlClose (NsSystemUpdateControl *c)
	Close a NsSystemUpdateControl.
Result	nssuControlHasDownloaded (NsSystemUpdateControl *c, bool *out)
	Gets whether a network sysupdate was downloaded, with install pending.
Result	nssuControlRequestCheckLatestUpdate (NsSystemUpdateControl *c, AsyncValue *a)
	RequestCheckLatestUpdate.
Result	nssuControlRequestDownloadLatestUpdate (NsSystemUpdateControl *c, AsyncResult *a)
	RequestDownloadLatestUpdate.
Result	nssuControlGetDownloadProgress (NsSystemUpdateControl *c, NsSystemUpdateProgress *out)
	GetDownloadProgress.
Result	nssuControlApplyDownloadedUpdate (NsSystemUpdateControl *c)
	ApplyDownloadedUpdate.
Result	nssuControlRequestPrepareCardUpdate (NsSystemUpdateControl *c, AsyncResult *a)
	RequestPrepareCardUpdate.
Result	nssuControlGetPrepareCardUpdateProgress (NsSystemUpdateControl *c, NsSystemUpdateProgress *out)
	GetPrepareCardUpdateProgress.
Result	nssuControlHasPreparedCardUpdate (NsSystemUpdateControl *c, bool *out)
	HasPreparedCardUpdate.
Result	nssuControlApplyCardUpdate (NsSystemUpdateControl *c)
	ApplyCardUpdate.
Result	nssuControlGetDownloadedEulaDataSize (NsSystemUpdateControl *c, const char *path, u64 *filesize)
	Gets the filesize for the specified DownloadedEulaData.
Result	nssuControlGetDownloadedEulaData (NsSystemUpdateControl *c, const char *path, void *buffer, size_t size, u64 *filesize)
	Gets the specified DownloadedEulaData.
Result	nssuControlSetupCardUpdate (NsSystemUpdateControl *c, void *buffer, size_t size)
	SetupCardUpdate.
Result	nssuControlGetPreparedCardUpdateEulaDataSize (NsSystemUpdateControl *c, const char *path, u64 *filesize)
	Gets the filesize for the specified PreparedCardUpdateEulaData.
Result	nssuControlGetPreparedCardUpdateEulaData (NsSystemUpdateControl *c, const char *path, void *buffer, size_t size, u64 *filesize)
	Gets the specified PreparedCardUpdateEulaData.
Result	nssuControlSetupCardUpdateViaSystemUpdater (NsSystemUpdateControl *c, void *buffer, size_t size)
	SetupCardUpdateViaSystemUpdater.
Result	nssuControlHasReceived (NsSystemUpdateControl *c, bool *out)
	HasReceived.
Result	nssuControlRequestReceiveSystemUpdate (NsSystemUpdateControl *c, AsyncResult *a, u32 addr, u16 port, NsSystemDeliveryInfo *info)
	RequestReceiveSystemUpdate.
Result	nssuControlGetReceiveProgress (NsSystemUpdateControl *c, NsSystemUpdateProgress *out)
	GetReceiveProgress.
Result	nssuControlApplyReceivedUpdate (NsSystemUpdateControl *c)
	ApplyReceivedUpdate.
Result	nssuControlGetReceivedEulaDataSize (NsSystemUpdateControl *c, const char *path, u64 *filesize)
	Gets the filesize for the specified ReceivedEulaData.
Result	nssuControlGetReceivedEulaData (NsSystemUpdateControl *c, const char *path, void *buffer, size_t size, u64 *filesize)
	Gets the specified ReceivedEulaData.
Result	nssuControlSetupToReceiveSystemUpdate (NsSystemUpdateControl *c)
	Does setup for ReceiveSystemUpdate by using the same nim cmds as nssuDestroySystemUpdateTask.
Result	nssuControlRequestCheckLatestUpdateIncludesRebootlessUpdate (NsSystemUpdateControl *c, AsyncValue *a)
	RequestCheckLatestUpdateIncludesRebootlessUpdate.

Detailed Description

NS services IPC wrapper.

Author

yellows8

Copyright

libnx Authors

Enumeration Type Documentation

NsApplicationControlSource

enum NsApplicationControlSource

ApplicationControlSource.

Enumerator
NsApplicationControlSource_CacheOnly	Returns data from cache.
NsApplicationControlSource_Storage	Returns data from storage if not present in cache.
NsApplicationControlSource_StorageOnly	Returns data from storage without using cache.

NsBackgroundNetworkUpdateState

enum NsBackgroundNetworkUpdateState

BackgroundNetworkUpdateState.

Enumerator
NsBackgroundNetworkUpdateState_None	No sysupdate task exists.
NsBackgroundNetworkUpdateState_Downloading	Sysupdate download in progress.
NsBackgroundNetworkUpdateState_Ready	Sysupdate ready, pending install.

NsLatestSystemUpdate

enum NsLatestSystemUpdate

LatestSystemUpdate.

Enumerator
NsLatestSystemUpdate_Unknown0	Unknown.
NsLatestSystemUpdate_Unknown1	Unknown.
NsLatestSystemUpdate_Unknown2	Unknown.

NsShellEvent

enum NsShellEvent

ShellEvent.

Enumerator
NsShellEvent_None	None.
NsShellEvent_Exit	Exit.
NsShellEvent_Start	Start.
NsShellEvent_Crash	Crash.
NsShellEvent_Debug	Debug.

Function Documentation

nsCalculateApplicationApplyDeltaRequiredSize()

Result nsCalculateApplicationApplyDeltaRequiredSize	(	u64	application_id,
		NcmStorageId *	storage_id,
		s64 *	size
	)

CalculateApplicationApplyDeltaRequiredSize.

Note

Only available on [3.0.0+].

Parameters

[in]	application_id	ApplicationId.
[out]	storage_id	Output NcmStorageId.
[out]	size	Output size.

nsCalculateApplicationDownloadRequiredSize()

Result nsCalculateApplicationDownloadRequiredSize	(	u64	application_id,
		NcmStorageId *	storage_id,
		s64 *	size
	)

CalculateApplicationApplyDeltaRequiredSize.

Parameters

[in]	application_id	ApplicationId.
[out]	storage_id	Output NcmStorageId.
[out]	size	Output size.

nsCalculateApplicationOccupiedSize()

Result nsCalculateApplicationOccupiedSize	(	u64	application_id,
		NsApplicationOccupiedSize *	out
	)

CalculateApplicationOccupiedSize.

Note

Uses nsGetContentManagementInterface on [3.0.0+], otherwise IApplicationManagerInterface is used.

Parameters

[in]	application_id	ApplicationId.
[out]	out	NsApplicationOccupiedSize

nsCancelApplicationApplyDelta()

Result nsCancelApplicationApplyDelta

(

u64

application_id

)

CancelApplicationApplyDelta.

Note

Only available on [3.0.0+].

Parameters

[in]

application_id

ApplicationId.

nsCancelApplicationDownload()

Result nsCancelApplicationDownload

(

u64

application_id

)

CancelApplicationDownload.

Parameters

[in]

application_id

ApplicationId.

nsCanDeliverApplication()

Result nsCanDeliverApplication	(	const NsApplicationDeliveryInfo *	info0,
		s32	count0,
		const NsApplicationDeliveryInfo *	info1,
		s32	count1,
		bool *	out
	)

CanDeliverApplication.

Note

Only available on [4.0.0+].

Parameters

[in]	info0	First input array of NsApplicationDeliveryInfo.
[in]	count0	Size of the info0 array in entries. Must be value <=1, when 0 this will return 0 with out set to 0.
[in]	info1	Second input array of NsApplicationDeliveryInfo.
[in]	count1	Size of the info1 array in entries. Must be value 1.
[out]	out	Output flag.

nsCheckApplicationLaunchVersion()

Result nsCheckApplicationLaunchVersion

(

u64

application_id

)

CheckApplicationLaunchVersion.

Parameters

[in]

application_id

ApplicationId.

nsCheckSdCardMountStatus()

Result nsCheckSdCardMountStatus

(

void

)

CheckSdCardMountStatus.

Note

Uses nsGetContentManagementInterface on [3.0.0+], otherwise IApplicationManagerInterface is used.

nsCleanupUnavailableAddOnContents()

Result nsCleanupUnavailableAddOnContents	(	u64	application_id,
		AccountUid	uid
	)

CleanupUnavailableAddOnContents.

Note

Only available on [6.0.0+].

Parameters

[in]	application_id	ApplicationId.
[in]	uid	AccountUid

nsClearApplicationTerminateResult()

Result nsClearApplicationTerminateResult

(

u64

application_id

)

ClearApplicationTerminateResult.

Parameters

[in]

application_id

ApplicationId.

nsClearTaskStatusList()

Result nsClearTaskStatusList

(

void

)

ClearTaskStatusList.

Note

Uses nsGetDownloadTaskInterface on [3.0.0+], otherwise IApplicationManagerInterface is used.

Only available on [2.0.0+].

nsCommitReceiveApplication()

Result nsCommitReceiveApplication

(

u64

application_id

)

CommitReceiveApplication.

Note

Only available on [4.0.0+].

Parameters

[in]

application_id

ApplicationId

nsCompareApplicationDeliveryInfo()

Result nsCompareApplicationDeliveryInfo	(	const NsApplicationDeliveryInfo *	info0,
		s32	count0,
		const NsApplicationDeliveryInfo *	info1,
		s32	count1,
		s32 *	out
	)

Both NsApplicationDeliveryInfo are validated, then the application_version in the first/second NsApplicationDeliveryInfo are compared.

Note

Only available on [4.0.0+].

Parameters

[in]	info0	First input array of NsApplicationDeliveryInfo.
[in]	count0	Size of the info0 array in entries. Must be value 1.
[in]	info1	Second input array of NsApplicationDeliveryInfo.
[in]	count1	Size of the info1 array in entries. Must be value 1.
[out]	out	Comparison result: -1 for less than, 0 for equal, and 1 for higher than.

nsCompareSystemDeliveryInfo()

Result nsCompareSystemDeliveryInfo	(	const NsSystemDeliveryInfo *	info0,
		const NsSystemDeliveryInfo *	info1,
		s32 *	out
	)

Both NsSystemDeliveryInfo are validated, then the system_update_meta_version in the first/second NsSystemDeliveryInfo are compared.

Note

Only available on [4.0.0+].

Parameters

[in]	info0	First NsSystemDeliveryInfo.
[in]	info1	Second NsSystemDeliveryInfo.
[out]	out	Comparison result: -1 for less than, 0 for equal, and 1 for higher than.

nsCountApplicationContentMeta()

Result nsCountApplicationContentMeta	(	u64	application_id,
		s32 *	out
	)

CountApplicationContentMeta.

Note

Uses nsGetContentManagementInterface on [3.0.0+], otherwise IApplicationManagerInterface is used.

Only available on [2.0.0+].

Parameters

[in]	application_id	ApplicationId.
[out]	out	Output count.

nsDeleteApplicationCompletely()

Result nsDeleteApplicationCompletely

(

u64

application_id

)

DeleteApplicationCompletely.

Parameters

[in]

application_id

ApplicationId.

nsDeleteApplicationEntity()

Result nsDeleteApplicationEntity

(

u64

application_id

)

DeleteApplicationEntity.

Parameters

[in]

application_id

ApplicationId.

nsDeleteSaveData()

Result nsDeleteSaveData	(	FsSaveDataSpaceId	save_data_space_id,
		u64	save_data_id
	)

DeleteSaveData.

Note

Only available on [6.0.0+].

Parameters

[in]	save_data_space_id	FsSaveDataSpaceId
[in]	save_data_id	SaveDataId

nsDeleteUserSaveDataAll()

Result nsDeleteUserSaveDataAll	(	NsProgressMonitorForDeleteUserSaveDataAll *	p,
		AccountUid	uid
	)

DeleteUserSaveDataAll.

Parameters

[in]	p	NsProgressMonitorForDeleteUserSaveDataAll
[in]	uid	AccountUid

nsDeleteUserSystemSaveData()

Result nsDeleteUserSystemSaveData	(	AccountUid	uid,
		u64	system_save_data_id
	)

DeleteUserSystemSaveData.

Parameters

[in]	uid	AccountUid
[in]	system_save_data_id	SystemSaveDataId

nsDisableApplicationAutoDelete()

Result nsDisableApplicationAutoDelete

(

u64

application_id

)

DisableApplicationAutoDelete.

Parameters

[in]

application_id

ApplicationId.

nsDisableAutoCommit()

Result nsDisableAutoCommit

(

void

)

DisableAutoCommit.

Note

Only available on [4.0.0+].

nsEnableApplicationAutoDelete()

Result nsEnableApplicationAutoDelete

(

u64

application_id

)

EnableApplicationAutoDelete.

Parameters

[in]

application_id

ApplicationId.

nsEnableAutoCommit()

Result nsEnableAutoCommit

(

void

)

EnableAutoCommit.

Note

Only available on [4.0.0+].

nsEnsureGameCardAccess()

Result nsEnsureGameCardAccess

(

void

)

EnsureGameCardAccess.

Note

Only available on [3.0.0+].

nsEstimateRequiredSize()

Result nsEstimateRequiredSize	(	const NcmContentMetaKey *	meta,
		s32	count,
		s64 *	out
	)

EstimateRequiredSize.

Note

Only available on [4.0.0+].

Parameters

[in]	meta	Input array of NcmContentMetaKey.
[in]	count	Size of the meta array in entries. When less than 1, this will return 0 with out set to 0.
[out]	out	Output size.

nsEstimateSizeToMove()

Result nsEstimateSizeToMove	(	u8 *	storage_ids,
		s32	count,
		NcmStorageId	storage_id,
		u32	flags,
		u64	application_id,
		s64 *	out
	)

EstimateSizeToMove.

Note

Only available on [10.0.0+].

Parameters

[in]	storage_ids	Array of u8 NcmStorageId.
[in]	count	Size of the storage_ids array in entries.
[in]	storage_id	storage_id NcmStorageId
[in]	flags	Flags
[in]	application_id	ApplicationId.
[out]	Out	Output value.

nsFormatSdCard()

Result nsFormatSdCard

(

void

)

FormatSdCard.

Note

Only available on [2.0.0+].

nsGetAccountProxyInterface()

Result nsGetAccountProxyInterface

(

Service *

srv_out

)

Gets the Service object for IAccountProxyInterface via the cmd for that.

Only available on [3.0.0+].

nsGetApplicationControlData()

Result nsGetApplicationControlData	(	NsApplicationControlSource	source,
		u64	application_id,
		NsApplicationControlData *	buffer,
		size_t	size,
		u64 *	actual_size
	)

Gets the NsApplicationControlData for the specified application.

Note

Uses nsGetReadOnlyApplicationControlDataInterface on [5.1.0+], otherwise IApplicationManagerInterface is used.

Parameters

[in]	source	Source, official sw uses NsApplicationControlSource_Storage.
[in]	application_id	ApplicationId.
[out]	buffer	NsApplicationControlData
[in]	size	Size of the buffer.
[out]	actual_size	Actual output size.

nsGetApplicationDeliveryInfo()

Result nsGetApplicationDeliveryInfo	(	NsApplicationDeliveryInfo *	info,
		s32	count,
		u64	application_id,
		u32	attr,
		s32 *	total_out
	)

Generates NsApplicationDeliveryInfo for the specified ApplicationId.

Note

Only available on [4.0.0+].

Parameters

[out]	info	Output array of NsApplicationDeliveryInfo.
[in]	count	Size of the array in entries.
[in]	application_id	ApplicationId
[in]	attr	ApplicationDeliveryAttributeTag bitmask.
[out]	total_out	Total output entries.

nsGetApplicationDeliveryInfoHash()

Result nsGetApplicationDeliveryInfoHash	(	const NsApplicationDeliveryInfo *	info,
		s32	count,
		u8 *	out_hash
	)

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

Note

Only available on [5.0.0+].

Parameters

[in]	info	Input array of NsApplicationDeliveryInfo.
[in]	count	Size of the array in entries.
[out]	out_hash	Output 0x20-byte SHA256 hash.

nsGetApplicationDesiredLanguage()

Result nsGetApplicationDesiredLanguage	(	NacpStruct *	nacp,
		NacpLanguageEntry **	langentry
	)

GetApplicationDesiredLanguage.

Selects a NacpLanguageEntry to use from the specified NacpStruct.

Note

Uses nsGetReadOnlyApplicationControlDataInterface on [5.1.0+], otherwise IApplicationManagerInterface is used.

Parameters

[in]	nacp	NacpStruct
[out]	langentry	NacpLanguageEntry

nsGetApplicationManagerInterface()

Result nsGetApplicationManagerInterface

(

Service *

srv_out

)

Gets the Service object for IApplicationManagerInterface via the cmd for that.

Only available on [3.0.0+], on prior sysvers use nsGetServiceSession_ApplicationManagerInterface.

nsGetApplicationRecordUpdateSystemEvent()

Result nsGetApplicationRecordUpdateSystemEvent

(

Event *

out_event

)

GetApplicationRecordUpdateSystemEvent.

Note

The Event must be closed by the user once finished with it.

Parameters

[out]

out_event

Output Event with autoclear=true.

nsGetApplicationRightsOnClient()

Result nsGetApplicationRightsOnClient	(	NsApplicationRightsOnClient *	rights,
		s32	count,
		u64	application_id,
		AccountUid	uid,
		u32	flags,
		s32 *	total_out
	)

GetApplicationRightsOnClient.

Note

Only available on [6.0.0+].

Parameters

[out]	rights	Output array of NsApplicationRightsOnClient.
[in]	count	Size of the rights array in entries. qlaunch uses value 3 for this.
[in]	application_id	ApplicationId
[in]	uid	AccountUid, can optionally be all-zero.
[in]	flags	Flags. Official sw hard-codes this to value 0x3.
[out]	total_out	Total output entries.

nsGetApplicationTerminateResult()

Result nsGetApplicationTerminateResult	(	u64	application_id,
		Result *	res
	)

GetApplicationTerminateResult.

Note

Only available on [6.0.0+].

Parameters

[in]	application_id	ApplicationId.
[out]	res	Output Result.

nsGetApplicationVersionInterface()

Result nsGetApplicationVersionInterface

(

Service *

srv_out

)

Gets the Service object for IApplicationVersionInterface via the cmd for that.

Only available on [4.0.0+].

nsGetApplicationView()

Result nsGetApplicationView	(	NsApplicationView *	views,
		const u64 *	application_ids,
		s32	count
	)

GetApplicationView.

Note

Only available on [3.0.0+], on prior system-versions use nsGetApplicationViewDeprecated instead.

Parameters

[out]	out	Output array of NsApplicationView.
[in]	application_ids	Input array of ApplicationIds.
[in]	count	Size of the input/output arrays in entries.

nsGetApplicationViewDeprecated()

Result nsGetApplicationViewDeprecated	(	NsApplicationViewDeprecated *	views,
		const u64 *	application_ids,
		s32	count
	)

GetApplicationViewDeprecated.

Note

On [3.0.0+] you should generally use nsGetApplicationView instead.

Parameters

[out]	out	Output array of NsApplicationViewDeprecated.
[in]	application_ids	Input array of ApplicationIds.
[in]	count	Size of the input/output arrays in entries.

nsGetApplicationViewDownloadErrorContext()

Result nsGetApplicationViewDownloadErrorContext	(	u64	application_id,
		ErrorContext *	context
	)

GetApplicationViewDownloadErrorContext.

Note

Only available on [4.0.0+].

Parameters

[in]	application_id	ApplicationId
[out]	context	ErrorContext

nsGetApplicationViewWithPromotionInfo()

Result nsGetApplicationViewWithPromotionInfo	(	NsApplicationViewWithPromotionInfo *	out,
		const u64 *	application_ids,
		s32	count
	)

GetApplicationViewWithPromotionInfo.

Note

Only available on [8.0.0+].

Parameters

[out]	out	Output array of NsApplicationViewWithPromotionInfo.
[in]	application_ids	Input array of ApplicationIds.
[in]	count	Size of the input/output arrays in entries.

nsGetContentManagementInterface()

Result nsGetContentManagementInterface

(

Service *

srv_out

)

Gets the Service object for IContentManagementInterface via the cmd for that.

Only available on [3.0.0+].

nsGetDocumentInterface()

Result nsGetDocumentInterface

(

Service *

srv_out

)

Gets the Service object for IDocumentInterface via the cmd for that.

Only available on [3.0.0+].

nsGetDownloadTaskInterface()

Result nsGetDownloadTaskInterface

(

Service *

srv_out

)

Gets the Service object for IDownloadTaskInterface via the cmd for that.

Only available on [3.0.0+].

nsGetDynamicRightsInterface()

Result nsGetDynamicRightsInterface

(

Service *

srv_out

)

Gets the Service object for IDynamicRightsInterface via the cmd for that.

Only available on [6.0.0+].

nsGetECommerceInterface()

Result nsGetECommerceInterface

(

Service *

srv_out

)

Gets the Service object for IECommerceInterface via the cmd for that.

Only available on [4.0.0+].

nsGetFactoryResetInterface()

Result nsGetFactoryResetInterface

(

Service *

srv_out

)

Gets the Service object for IFactoryResetInterface via the cmd for that.

Only available on [3.0.0+].

nsGetFreeSpaceSize()

Result nsGetFreeSpaceSize	(	NcmStorageId	storage_id,
		s64 *	size
	)

Returns the available storage capacity from content manager services.

Note

Uses nsGetContentManagementInterface on [3.0.0+], otherwise IApplicationManagerInterface is used.

Parameters

[in]	storage_id	NcmStorageId. Must be NcmStorageId_SdCard.
[out]	size	Pointer to output the free storage size to.

nsGetGameCardMountFailureEvent()

Result nsGetGameCardMountFailureEvent

(

Event *

out_event

)

GetGameCardMountFailureEvent.

Note

The Event must be closed by the user once finished with it.

Only available on [3.0.0+].

Parameters

[out]

out_event

Output Event with autoclear=false.

nsGetGameCardUpdateDetectionEvent()

Result nsGetGameCardUpdateDetectionEvent

(

Event *

out_event

)

GetGameCardUpdateDetectionEvent.

Note

The Event must be closed by the user once finished with it.

Parameters

[out]

out_event

Output Event with autoclear=false.

nsGetLastGameCardMountFailureResult()

Result nsGetLastGameCardMountFailureResult

(

void

)

GetLastGameCardMountFailureResult.

Note

Only available on [3.0.0+].

nsGetLastSdCardFormatUnexpectedResult()

Result nsGetLastSdCardFormatUnexpectedResult

(

void

)

GetLastSdCardFormatUnexpectedResult.

Note

Only available on [2.0.0+].

nsGetPromotionInfo()

Result nsGetPromotionInfo	(	NsPromotionInfo *	promotion,
		u64	application_id,
		AccountUid	uid
	)

GetPromotionInfo.

Note

Only available on [8.0.0+].

Parameters

[out]	promotion	NsPromotionInfo
	application_id	ApplicationId.
[in]	uid	AccountUid

nsGetReadOnlyApplicationControlDataInterface()

Result nsGetReadOnlyApplicationControlDataInterface

(

Service *

srv_out

)

Gets the Service object for IReadOnlyApplicationControlDataInterface via the cmd for that.

Only available on [5.1.0+].

nsGetReadOnlyApplicationRecordInterface()

Result nsGetReadOnlyApplicationRecordInterface

(

Service *

srv_out

)

Gets the Service object for IReadOnlyApplicationRecordInterface via the cmd for that.

Only available on [5.0.0+].

nsGetReceiveApplicationProgress()

Result nsGetReceiveApplicationProgress	(	u64	application_id,
		NsReceiveApplicationProgress *	out
	)

GetReceiveApplicationProgress.

Note

Only available on [4.0.0+].

Parameters

[in]	application_id	ApplicationId
[out]	out	NsReceiveApplicationProgress

nsGetRequestServerStopper()

Result nsGetRequestServerStopper

(

NsRequestServerStopper *

r

)

Opens a NsRequestServerStopper.

Note

Only available on [2.0.0+].

Parameters

[out]

r

NsRequestServerStopper

nsGetSdCardMountStatusChangedEvent()

Result nsGetSdCardMountStatusChangedEvent

(

Event *

out_event

)

GetSdCardMountStatusChangedEvent.

Note

The Event must be closed by the user once finished with it.

Parameters

[out]

out_event

Output Event with autoclear=false.

nsGetSendApplicationProgress()

Result nsGetSendApplicationProgress	(	u64	application_id,
		NsSendApplicationProgress *	out
	)

GetSendApplicationProgress.

Note

Only available on [4.0.0+].

Parameters

[in]	application_id	ApplicationId
[out]	out	NsSendApplicationProgress

nsGetStorageSize()

Result nsGetStorageSize	(	NcmStorageId	storage_id,
		s64 *	total_space_size,
		s64 *	free_space_size
	)

Temporarily mounts the specified fs ContentStorage, then uses fs GetTotalSpaceSize/GetFreeSpaceSize with that mounted ContentStorage.

Note

Only available on [3.0.0+].

Parameters

[in]	storage_id	NcmStorageId, must be NcmStorageId_BuiltInUser or NcmStorageId_SdCard.
[out]	total_space_size	Output from GetTotalSpaceSize.
[out]	free_space_size	Output from GetFreeSpaceSize.

nsGetSystemDeliveryInfo()

Result nsGetSystemDeliveryInfo

(

NsSystemDeliveryInfo *

info

)

Generates a NsSystemDeliveryInfo using the currently installed SystemUpdate meta.

Note

Only available on [4.0.0+].

Parameters

[out]

info

NsSystemDeliveryInfo

nsGetTotalSpaceSize()

Result nsGetTotalSpaceSize	(	NcmStorageId	storage_id,
		s64 *	size
	)

Returns the total storage capacity (used + free) from content manager services.

Note

Uses nsGetContentManagementInterface on [3.0.0+], otherwise IApplicationManagerInterface is used.

Parameters

[in]	storage_id	NcmStorageId. Must be NcmStorageId_SdCard.
[out]	size	Pointer to output the total storage size to.

nsHasAllContentsToDeliver()

Result nsHasAllContentsToDeliver	(	const NsApplicationDeliveryInfo *	info,
		s32	count,
		bool *	out
	)

HasAllContentsToDeliver.

Note

Only available on [4.0.0+].

Parameters

[in]	info	Input array of NsApplicationDeliveryInfo.
[in]	count	Size of the array in entries. Must be value 1.
[out]	out	Output flag.

nsIsAnyApplicationEntityInstalled()

Result nsIsAnyApplicationEntityInstalled	(	u64	application_id,
		bool *	out
	)

IsAnyApplicationEntityInstalled.

Note

Only available on [2.0.0+].

Parameters

[in]	application_id	ApplicationId.
[out]	out	Output flag.

nsIsAnyApplicationRunning()

Result nsIsAnyApplicationRunning

(

bool *

out

)

IsAnyApplicationRunning.

Note

Only available on [3.0.0+].

Parameters

[out]

out

Output flag.

nsIsApplicationEntityMovable()

Result nsIsApplicationEntityMovable	(	u64	application_id,
		NcmStorageId	storage_id,
		bool *	out
	)

IsApplicationEntityMovable.

Parameters

[in]	application_id	ApplicationId.
[in]	storage_id	NcmStorageId
[out]	out	Output flag.

nsIsApplicationUpdateRequested()

Result nsIsApplicationUpdateRequested	(	u64	application_id,
		bool *	flag,
		u32 *	out
	)

IsApplicationUpdateRequested.

Note

Only available on [2.0.0+].

Parameters

[in]	application_id	ApplicationId.
[out]	flag	Output flag, indicating whether out is valid.
[out]	out	Output value.

nsIsGameCardInserted()

Result nsIsGameCardInserted

(

bool *

out

)

IsGameCardInserted.

Note

Only available on [3.0.0+].

Parameters

[out]

out

Output flag.

nsListApplicationContentMetaStatus()

Result nsListApplicationContentMetaStatus	(	u64	application_id,
		s32	index,
		NsApplicationContentMetaStatus *	list,
		s32	count,
		s32 *	out_entrycount
	)

Gets an listing of NsApplicationContentMetaStatus.

Note

Uses nsGetContentManagementInterface on [3.0.0+], otherwise IApplicationManagerInterface is used.

Only available on [2.0.0+].

Parameters

[in]	application_id	ApplicationId.
[in]	index	Starting entry index.
[out]	list	Output array of NsApplicationContentMetaStatus.
[in]	count	Size of the list array in entries.
[out]	out_entrycount	Total output entries.

nsListApplicationIcon()

Result nsListApplicationIcon	(	AsyncValue *	a,
		NsApplicationControlSource	source,
		const u64 *	application_ids,
		s32	count,
		void *	buffer,
		size_t	size
	)

ListApplicationIcon.

Note

The data available with asyncValueGet is a s32 for the offset within the buffer where the output data is located, asyncValueGetSize 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.

Only available on [8.0.0+].

Parameters

[out]	a	AsyncValue
[in]	source	Source.
[in]	application_ids	Input array of ApplicationIds.
[in]	count	Size of the application_ids array in entries.
	buffer	0x1000-byte aligned buffer for TransferMemory. This buffer must not be accessed until the async operation finishes.
[in]	size	0x1000-byte aligned buffer size for TransferMemory. This must be at least: 0x4 + count*sizeof(u64) + count*sizeof(NsApplicationControlData::icon) + count*sizeof(u64) + sizeof(NsApplicationControlData).

nsListApplicationIdOnGameCard()

Result nsListApplicationIdOnGameCard	(	u64 *	application_ids,
		s32	count,
		s32 *	total_out
	)

ListApplicationIdOnGameCard.

Note

Only available on [5.0.0+].

Parameters

[out]	application_ids	Output array of ApplicationIds.
[in]	count	Size of the application_ids array in entries.
[out]	total_out	Total output entries.

nsListApplicationRecord()

Result nsListApplicationRecord	(	NsApplicationRecord *	records,
		s32	count,
		s32	entry_offset,
		s32 *	out_entrycount
	)

Gets an listing of NsApplicationRecord.

Parameters

[out]	records	Output array of NsApplicationRecord.
[in]	count	Size of the records array in entries.
[in]	entry_offset	Starting entry offset.
[out]	out_entrycount	Total output entries.

nsListApplicationTitle()

Result nsListApplicationTitle	(	AsyncValue *	a,
		NsApplicationControlSource	source,
		const u64 *	application_ids,
		s32	count,
		void *	buffer,
		size_t	size
	)

ListApplicationTitle.

Note

The data available with asyncValueGet is a s32 for the offset within the buffer where the output data is located, asyncValueGetSize returns the total byte-size of the data located here. The data located here is the NacpLanguageEntry for each specified ApplicationId.

Only available on [8.0.0+].

Parameters

[out]	a	AsyncValue
[in]	source	Source, qlaunch uses NsApplicationControlSource_Storage.
[in]	application_ids	Input array of ApplicationIds.
[in]	count	Size of the application_ids array in entries.
	buffer	0x1000-byte aligned buffer for TransferMemory. This buffer must not be accessed until the async operation finishes.
[in]	size	0x1000-byte aligned buffer size for TransferMemory. This must be at least: count*sizeof(NacpLanguageEntry) + count*sizeof(u64) + count*sizeof(NsApplicationControlData).

nsListContentMetaKeyToDeliverApplication()

Result nsListContentMetaKeyToDeliverApplication	(	NcmContentMetaKey *	meta,
		s32	meta_count,
		s32	meta_index,
		const NsApplicationDeliveryInfo *	info,
		s32	info_count,
		s32 *	total_out
	)

ListContentMetaKeyToDeliverApplication.

Note

Only available on [4.0.0+].

Parameters

[out]	meta	Output array of NcmContentMetaKey.
[in]	meta_count	Size of the meta array in entries. Must be at least 1, only 1 entry will be returned.
[in]	meta_index	Meta entry index. An output NcmContentMetaKey will not be returned when this value is larger than 0.
[in]	info	Input array of NsApplicationDeliveryInfo.
[in]	info_count	Size of the info array in entries. Must be value 1.
[out]	total_out	Total output entries.

nsListDownloadTaskStatus()

Result nsListDownloadTaskStatus	(	NsDownloadTaskStatus *	tasks,
		s32	count,
		s32 *	total_out
	)

ListDownloadTaskStatus.

Note

Uses nsGetDownloadTaskInterface on [3.0.0+], otherwise IApplicationManagerInterface is used.

Only available on [2.0.0+].

Parameters

[out]	tasks	Output array of NsDownloadTaskStatus.
[in]	count	Size of the tasks array in entries. A maximum of 0x100 tasks can be stored in state.
[out]	total_out	Total output entries.

nsListNotCommittedContentMeta()

Result nsListNotCommittedContentMeta	(	NcmContentMetaKey *	meta,
		s32	count,
		u64	application_id,
		s32	unk,
		s32 *	total_out
	)

ListNotCommittedContentMeta.

Note

Only available on [4.0.0+].

Parameters

[out]	meta	Output array of NcmContentMetaKey.
[in]	count	Size of the meta array in entries.
[in]	application_id	ApplicationId
[in]	unk	Unknown.
[out]	total_out	Total output entries.

nsMoveApplicationEntity()

Result nsMoveApplicationEntity	(	u64	application_id,
		NcmStorageId	storage_id
	)

MoveApplicationEntity.

Note

Only available on [1.0.0-9.2.0].

Parameters

[in]	application_id	ApplicationId.
[in]	storage_id	NcmStorageId

nsNeedsSystemUpdateToDeliverApplication()

Result nsNeedsSystemUpdateToDeliverApplication	(	const NsApplicationDeliveryInfo *	info,
		s32	count,
		const NsSystemDeliveryInfo *	sys_info,
		bool *	out
	)

After validation etc, this sets the output bool by comparing system-version fields in the NsSystemDeliveryInfo / info-array and with a state field.

Note

Only available on [4.0.0+].

Parameters

[in]	info	Input array of NsApplicationDeliveryInfo.
[in]	count	Size of the info array in entries. Must be value 1.
[in]	sys_info	NsSystemDeliveryInfo
[out]	out	Output flag.

nsNeedsSystemUpdateToFormatSdCard()

Result nsNeedsSystemUpdateToFormatSdCard

(

bool *

out

)

NeedsSystemUpdateToFormatSdCard.

Note

Only available on [2.0.0+].

Parameters

[out]

out

Output flag.

nsProgressAsyncResultCancel()

Result nsProgressAsyncResultCancel

(

NsProgressAsyncResult *

a

)

Cancels the async operation.

Note

Used automatically by nsProgressAsyncResultClose.

Parameters

a	NsProgressAsyncResult

nsProgressAsyncResultClose()

void nsProgressAsyncResultClose

(

NsProgressAsyncResult *

a

)

Close a NsProgressAsyncResult.

Note

When the object is initialized, this uses nsProgressAsyncResultCancel then nsProgressAsyncResultWait with timeout=UINT64_MAX.

Parameters

a	NsProgressAsyncResult

nsProgressAsyncResultGet()

Result nsProgressAsyncResultGet

(

NsProgressAsyncResult *

a

)

Gets the Result.

Note

Prior to using the cmd, this uses nsProgressAsyncResultWait with timeout=UINT64_MAX.

Parameters

a	NsProgressAsyncResult

nsProgressAsyncResultGetDetailResult()

Result nsProgressAsyncResultGetDetailResult

(

NsProgressAsyncResult *

a

)

GetDetailResult.

Parameters

a	NsProgressAsyncResult

nsProgressAsyncResultGetErrorContext()

Result nsProgressAsyncResultGetErrorContext	(	NsProgressAsyncResult *	a,
		ErrorContext *	context
	)

Gets the ErrorContext.

Note

Only available on [4.0.0+].

Parameters

	a	NsProgressAsyncResult
[out]	context	ErrorContext

nsProgressAsyncResultGetProgress()

Result nsProgressAsyncResultGetProgress	(	NsProgressAsyncResult *	a,
		void *	buffer,
		size_t	size
	)

Gets the progress.

Parameters

	a	NsProgressAsyncResult
[out]	buffer	Output buffer.
[in]	size	Output buffer size.

nsProgressAsyncResultWait()

Result nsProgressAsyncResultWait	(	NsProgressAsyncResult *	a,
		u64	timeout
	)

Waits for the async operation to finish using the specified timeout.

Parameters

	a	NsProgressAsyncResult
[in]	timeout	Timeout in nanoseconds. UINT64_MAX for no timeout.

nsProgressMonitorForDeleteUserSaveDataAllClose()

Result nsProgressMonitorForDeleteUserSaveDataAllClose

(

NsProgressMonitorForDeleteUserSaveDataAll *

p

)

Close a NsProgressMonitorForDeleteUserSaveDataAll.

When initialized this will use nsProgressMonitorForDeleteUserSaveDataAllIsFinished, throwing errors on failure / when the operation isn't finished (without closing the object).

Note

Cancelling the operation before it's finished is not supported by NsProgressMonitorForDeleteUserSaveDataAll.

Parameters

p	NsProgressMonitorForDeleteUserSaveDataAll

nsProgressMonitorForDeleteUserSaveDataAllGetProgress()

Result nsProgressMonitorForDeleteUserSaveDataAllGetProgress	(	NsProgressMonitorForDeleteUserSaveDataAll *	p,
		NsProgressForDeleteUserSaveDataAll *	progress
	)

GetProgress.

Parameters

	p	NsProgressMonitorForDeleteUserSaveDataAll
[out]	progress	Output NsProgressForDeleteUserSaveDataAll.

nsProgressMonitorForDeleteUserSaveDataAllGetResult()

Result nsProgressMonitorForDeleteUserSaveDataAllGetResult

(

NsProgressMonitorForDeleteUserSaveDataAll *

p

)

GetResult.

Parameters

p	NsProgressMonitorForDeleteUserSaveDataAll

nsProgressMonitorForDeleteUserSaveDataAllGetSystemEvent()

Result nsProgressMonitorForDeleteUserSaveDataAllGetSystemEvent	(	NsProgressMonitorForDeleteUserSaveDataAll *	p,
		Event *	out_event
	)

GetSystemEvent.

Note

The Event must be closed by the user once finished with it.

Parameters

[out]

out_event

Output Event with autoclear=false.

nsProgressMonitorForDeleteUserSaveDataAllIsFinished()

Result nsProgressMonitorForDeleteUserSaveDataAllIsFinished	(	NsProgressMonitorForDeleteUserSaveDataAll *	p,
		bool *	out
	)

IsFinished.

Parameters

	p	NsProgressMonitorForDeleteUserSaveDataAll
[out]	out	Whether the operation finished.

nsRequestApplicationUpdateInfo()

Result nsRequestApplicationUpdateInfo	(	AsyncValue *	a,
		u64	application_id
	)

RequestApplicationUpdateInfo.

Note

nifmInitialize must be used prior to this. Before using the cmd, this calls nifmIsAnyInternetRequestAccepted with the output from nifmGetClientId, an error is returned when that returns false.

Parameters

[out]	a	AsyncValue. The data that can be read from this is u8 ApplicationUpdateInfo. qlaunch just checks whether this is 0.
	application_id	ApplicationId.

nsRequestCheckGameCardRegistration()

Result nsRequestCheckGameCardRegistration	(	AsyncResult *	a,
		u64	application_id
	)

RequestCheckGameCardRegistration.

Note

nifmInitialize must be used prior to this. Before using the cmd, this calls nifmIsAnyInternetRequestAccepted with the output from nifmGetClientId, an error is returned when that returns false.

Only available on [2.0.0+].

Parameters

[out]	a	AsyncResult
[in]	application_id	ApplicationId.

nsRequestDownloadApplicationControlData()

Result nsRequestDownloadApplicationControlData	(	AsyncResult *	a,
		u64	application_id
	)

RequestDownloadApplicationControlData.

Note

nifmInitialize must be used prior to this. Before using the cmd, this calls nifmIsAnyInternetRequestAccepted with the output from nifmGetClientId, an error is returned when that returns false.

Parameters

[out]	a	AsyncResult
[in]	application_id	ApplicationId.

nsRequestDownloadApplicationPrepurchasedRights()

Result nsRequestDownloadApplicationPrepurchasedRights	(	AsyncResult *	a,
		u64	application_id
	)

RequestDownloadApplicationPrepurchasedRights.

Note

nifmInitialize must be used prior to this. Before using the cmd, this calls nifmIsAnyInternetRequestAccepted with the output from nifmGetClientId, an error is returned when that returns false.

Only available on [4.0.0+].

Parameters

[out]	a	AsyncResult
[in]	application_id	ApplicationId.

nsRequestDownloadTaskList()

Result nsRequestDownloadTaskList

(

void

)

RequestDownloadTaskList.

Note

Uses nsGetDownloadTaskInterface on [3.0.0+], otherwise IApplicationManagerInterface is used.

Only available on [2.0.0+].

nsRequestDownloadTaskListData()

Result nsRequestDownloadTaskListData

(

AsyncValue *

a

)

RequestDownloadTaskListData.

Note

Uses nsGetDownloadTaskInterface on [3.0.0+], otherwise IApplicationManagerInterface is used.

Only available on [2.0.0+].

Parameters

[out]

a

AsyncValue

nsRequestEnsureDownloadTask()

Result nsRequestEnsureDownloadTask

(

AsyncResult *

a

)

RequestEnsureDownloadTask.

Note

Uses nsGetDownloadTaskInterface on [3.0.0+], otherwise IApplicationManagerInterface is used.

Only available on [2.0.0+].

Parameters

[out]

a

AsyncResult

nsRequestGameCardRegistrationGoldPoint()

Result nsRequestGameCardRegistrationGoldPoint	(	AsyncValue *	a,
		AccountUid	uid,
		u64	application_id
	)

RequestGameCardRegistrationGoldPoint.

Note

nifmInitialize must be used prior to this. Before using the cmd, this calls nifmIsAnyInternetRequestAccepted with the output from nifmGetClientId, an error is returned when that returns false.

Only available on [2.0.0+].

Parameters

[out]	a	AsyncValue. The data that can be read from this is 4-bytes.
[in]	uid	AccountUid
[in]	application_id	ApplicationId.

nsRequestLinkDevice()

Result nsRequestLinkDevice	(	AsyncResult *	a,
		AccountUid	uid
	)

RequestLinkDevice.

Note

nifmInitialize must be used prior to this. Before using the cmd, this calls nifmIsAnyInternetRequestAccepted with the output from nifmGetClientId, an error is returned when that returns false.

Only available on [4.0.0+].

Parameters

[out]	a	AsyncResult
[in]	uid	AccountUid

nsRequestNoDownloadRightsErrorResolution()

Result nsRequestNoDownloadRightsErrorResolution	(	AsyncValue *	a,
		u64	application_id
	)

RequestNoDownloadRightsErrorResolution.

Note

nifmInitialize must be used prior to this. Before using the cmd, this calls nifmIsAnyInternetRequestAccepted with the output from nifmGetClientId, an error is returned when that returns false.

Only available on [9.0.0+].

Parameters

[out]	a	AsyncValue. The data that can be read from this is u8 NoDownloadRightsErrorResolution.
	application_id	ApplicationId.

nsRequestReceiveApplication()

Result nsRequestReceiveApplication	(	AsyncResult *	a,
		u32	addr,
		u16	port,
		u64	application_id,
		const NcmContentMetaKey *	meta,
		s32	count,
		NcmStorageId	storage_id
	)

RequestReceiveApplication.

Note

This is the Application version of nssuControlRequestReceiveSystemUpdate, see the notes for that.

Only available on [4.0.0+].

Parameters

[out]	a	AsyncResult
[in]	addr	Server IPv4 address.
[in]	port	Socket port. qlaunch uses value 55556.
[in]	application_id	ApplicationId
[in]	meta	Input array of NcmContentMetaKey. The NcmContentMetaType must match NcmContentMetaType_Patch.
[in]	count	Size of the meta array in entries.
[in]	storage_id	NcmStorageId. qlaunch uses NcmStorageId_Any.

nsRequestRegisterGameCard()

Result nsRequestRegisterGameCard	(	AsyncResult *	a,
		AccountUid	uid,
		u64	application_id,
		s32	inval
	)

RequestRegisterGameCard.

Note

nifmInitialize must be used prior to this. Before using the cmd, this calls nifmIsAnyInternetRequestAccepted with the output from nifmGetClientId, an error is returned when that returns false.

Only available on [2.0.0+].

Parameters

[out]	a	AsyncResult
[in]	uid	AccountUid
[in]	application_id	ApplicationId.
[in]	inval	Input value.

nsRequestResolveNoDownloadRightsError()

Result nsRequestResolveNoDownloadRightsError	(	AsyncValue *	a,
		u64	application_id
	)

RequestResolveNoDownloadRightsError.

Note

nifmInitialize must be used prior to this. Before using the cmd, this calls nifmIsAnyInternetRequestAccepted with the output from nifmGetClientId, an error is returned when that returns false.

Only available on [9.0.0+].

Parameters

[out]	a	AsyncValue. The data that can be read from this is u8 NoDownloadRightsErrorResolution.
	application_id	ApplicationId.

nsRequestSendApplication()

Result nsRequestSendApplication	(	AsyncResult *	a,
		u32	addr,
		u16	port,
		u64	application_id,
		const NcmContentMetaKey *	meta,
		s32	count
	)

RequestSendApplication.

Note

This is the Application version of nssuRequestSendSystemUpdate, see the notes for that.

Only available on [4.0.0+].

Parameters

[out]	a	AsyncResult
[in]	addr	Client IPv4 address.
[in]	port	Socket port. qlaunch uses value 55556.
[in]	application_id	ApplicationId
[in]	meta	Input array of NcmContentMetaKey. The NcmContentMetaType must match NcmContentMetaType_Patch.
[in]	count	Size of the meta array in entries.

nsRequestServerStopperClose()

void nsRequestServerStopperClose

(

NsRequestServerStopper *

r

)

Close a NsRequestServerStopper.

Parameters

r	NsRequestServerStopper

nsRequestSyncRights()

Result nsRequestSyncRights

(

AsyncResult *

a

)

RequestSyncRights.

Note

Only available on [6.0.0+].

Parameters

[out]

a

AsyncResult

nsRequestUnlinkDevice()

Result nsRequestUnlinkDevice	(	AsyncResult *	a,
		AccountUid	uid
	)

RequestUnlinkDevice.

Note

nifmInitialize must be used prior to this. Before using the cmd, this calls nifmIsAnyInternetRequestAccepted with the output from nifmGetClientId, an error is returned when that returns false.

Only available on [6.0.0+].

Parameters

[out]	a	AsyncResult
[in]	uid	AccountUid

nsRequestUpdateApplication2()

Result nsRequestUpdateApplication2	(	AsyncResult *	a,
		u64	application_id
	)

RequestUpdateApplication2.

Note

nifmInitialize must be used prior to this. Before using the cmd, this calls nifmIsAnyInternetRequestAccepted with the output from nifmGetClientId, an error is returned when that returns false.

Only available on [4.0.0+].

Parameters

[out]	a	AsyncResult
[in]	application_id	ApplicationId.

nsRequestVerifyAddOnContentsRights()

Result nsRequestVerifyAddOnContentsRights	(	NsProgressAsyncResult *	a,
		u64	application_id
	)

RequestVerifyAddOnContentsRights.

Note

Only available on [3.0.0-9.2.0].

Parameters

[out]	a	NsProgressAsyncResult
[in]	application_id	ApplicationId.

nsRequestVerifyApplication()

Result nsRequestVerifyApplication	(	NsProgressAsyncResult *	a,
		u64	application_id,
		u32	unk,
		void *	buffer,
		size_t	size
	)

RequestVerifyApplication.

Note

On pre-5.0.0 this uses cmd RequestVerifyApplicationDeprecated, otherwise cmd RequestVerifyApplication is used.

Parameters

[out]	a	NsProgressAsyncResult. The data available with nsProgressAsyncResultGetProgress is basically the same as NsSystemUpdateProgress.
[in]	application_id	ApplicationId.
[in]	unk	Unknown. A default value of 0x7 can be used (which is what qlaunch uses). Only used on [5.0.0+].
	buffer	0x1000-byte aligned buffer for TransferMemory. This buffer must not be accessed until the async operation finishes.
[in]	size	0x1000-byte aligned buffer size for TransferMemory. qlaunch uses size 0x100000.

nsResetToFactorySettings()

Result nsResetToFactorySettings

(

void

)

ResetToFactorySettings.

Note

Uses nsGetFactoryResetInterface on [3.0.0+], otherwise IApplicationManagerInterface is used.

nsResetToFactorySettingsForRefurbishment()

Result nsResetToFactorySettingsForRefurbishment

(

void

)

ResetToFactorySettingsForRefurbishment.

Note

Uses nsGetFactoryResetInterface on [3.0.0+], otherwise IApplicationManagerInterface is used.

Only available on [2.0.0+].

nsResetToFactorySettingsWithoutUserSaveData()

Result nsResetToFactorySettingsWithoutUserSaveData

(

void

)

ResetToFactorySettingsWithoutUserSaveData.

Note

Uses nsGetFactoryResetInterface on [3.0.0+], otherwise IApplicationManagerInterface is used.

nsResetToFactorySettingsWithPlatformRegion()

Result nsResetToFactorySettingsWithPlatformRegion

(

void

)

ResetToFactorySettingsWithPlatformRegion.

Note

Only available on [9.1.0+].

nsResetToFactorySettingsWithPlatformRegionAuthentication()

Result nsResetToFactorySettingsWithPlatformRegionAuthentication

(

void

)

ResetToFactorySettingsWithPlatformRegionAuthentication.

Note

Only available on [9.1.0+].

nsResumeAll()

Result nsResumeAll

(

void

)

ResumeAll.

Note

Only available on [3.0.0+].

nsResumeApplicationApplyDelta()

Result nsResumeApplicationApplyDelta

(

u64

application_id

)

ResumeApplicationApplyDelta.

Note

Only available on [3.0.0+].

Parameters

[in]

application_id

ApplicationId.

nsResumeApplicationDownload()

Result nsResumeApplicationDownload

(

u64

application_id

)

ResumeApplicationDownload.

Parameters

[in]

application_id

ApplicationId.

nsSelectLatestSystemDeliveryInfo()

Result nsSelectLatestSystemDeliveryInfo	(	const NsSystemDeliveryInfo *	sys_list,
		s32	sys_count,
		const NsSystemDeliveryInfo *	base_info,
		const NsApplicationDeliveryInfo *	app_list,
		s32	app_count,
		s32 *	index
	)

SelectLatestSystemDeliveryInfo.

Note

This selects the NsSystemDeliveryInfo with the latest version from sys_list, using minimum versions determined from app_list/state and base_info. This also does various validation, etc.

Only available on [4.0.0+].

Parameters

[in]	sys_list	Input array of NsSystemDeliveryInfo.
[in]	sys_count	Size of the sys_list array in entries.
[in]	base_info	NsSystemDeliveryInfo
[in]	app_list	Input array of NsApplicationDeliveryInfo. This can be NULL.
[in]	app_count	Size of the app_list array in entries. This can be 0.
[out]	index	Output index for the selected entry in sys_list, -1 if none found.

nsSetApplicationTerminateResult()

Result nsSetApplicationTerminateResult	(	u64	application_id,
		Result	res
	)

SetApplicationTerminateResult.

Parameters

[in]	application_id	ApplicationId.
[in]	res	Result.

nssuControlApplyCardUpdate()

Result nssuControlApplyCardUpdate

(

NsSystemUpdateControl *

c

)

ApplyCardUpdate.

Note

nssuControlSetupCardUpdate / nssuControlSetupCardUpdateViaSystemUpdater must have been used at some point prior to using this.

Parameters

c	NsSystemUpdateControl

nssuControlApplyDownloadedUpdate()

Result nssuControlApplyDownloadedUpdate

(

NsSystemUpdateControl *

c

)

ApplyDownloadedUpdate.

Parameters

c	NsSystemUpdateControl

nssuControlApplyReceivedUpdate()

Result nssuControlApplyReceivedUpdate

(

NsSystemUpdateControl *

c

)

ApplyReceivedUpdate.

Note

Only available on [4.0.0+].

Parameters

c	NsSystemUpdateControl

nssuControlClose()

void nssuControlClose

(

NsSystemUpdateControl *

c

)

Close a NsSystemUpdateControl.

Parameters

c	NsSystemUpdateControl

nssuControlGetDownloadedEulaData()

Result nssuControlGetDownloadedEulaData	(	NsSystemUpdateControl *	c,
		const char *	path,
		void *	buffer,
		size_t	size,
		u64 *	filesize
	)

Gets the specified DownloadedEulaData.

Note

See the note for nssuControlGetDownloadedEulaDataSize.

Parameters

	c	NsSystemUpdateControl
[in]	path	EulaData path.
[out]	buffer	Output buffer.
[in]	size	Size of the output buffer, must be at least the output size from nssuControlGetDownloadedEulaDataSize.
[out]	filesize	Output filesize.

nssuControlGetDownloadedEulaDataSize()

Result nssuControlGetDownloadedEulaDataSize	(	NsSystemUpdateControl *	c,
		const char *	path,
		u64 *	filesize
	)

Gets the filesize for the specified DownloadedEulaData.

Note

This mounts the Eula SystemData, then uses the file "<mountname>:/<input path>".

Parameters

	c	NsSystemUpdateControl
[in]	path	EulaData path.
[out]	filesize	Output filesize.

nssuControlGetDownloadProgress()

Result nssuControlGetDownloadProgress	(	NsSystemUpdateControl *	c,
		NsSystemUpdateProgress *	out
	)

GetDownloadProgress.

Parameters

	c	NsSystemUpdateControl
[out]	out	NsSystemUpdateProgress

nssuControlGetPrepareCardUpdateProgress()

Result nssuControlGetPrepareCardUpdateProgress	(	NsSystemUpdateControl *	c,
		NsSystemUpdateProgress *	out
	)

GetPrepareCardUpdateProgress.

Note

nssuControlSetupCardUpdate / nssuControlSetupCardUpdateViaSystemUpdater must have been used at some point prior to using this.

Parameters

	c	NsSystemUpdateControl
[out]	out	NsSystemUpdateProgress

nssuControlGetPreparedCardUpdateEulaData()

Result nssuControlGetPreparedCardUpdateEulaData	(	NsSystemUpdateControl *	c,
		const char *	path,
		void *	buffer,
		size_t	size,
		u64 *	filesize
	)

Gets the specified PreparedCardUpdateEulaData.

Note

See the note for nssuControlGetDownloadedEulaDataSize.

Parameters

	c	NsSystemUpdateControl
[in]	path	EulaData path.
[out]	buffer	Output buffer.
[in]	size	Size of the output buffer, must be at least the output size from nssuControlGetPreparedCardUpdateEulaDataSize.
[out]	filesize	Output filesize.

nssuControlGetPreparedCardUpdateEulaDataSize()

Result nssuControlGetPreparedCardUpdateEulaDataSize	(	NsSystemUpdateControl *	c,
		const char *	path,
		u64 *	filesize
	)

Gets the filesize for the specified PreparedCardUpdateEulaData.

Note

See the note for nssuControlGetDownloadedEulaDataSize.

Parameters

	c	NsSystemUpdateControl
[in]	path	EulaData path.
[out]	filesize	Output filesize.

nssuControlGetReceivedEulaData()

Result nssuControlGetReceivedEulaData	(	NsSystemUpdateControl *	c,
		const char *	path,
		void *	buffer,
		size_t	size,
		u64 *	filesize
	)

Gets the specified ReceivedEulaData.

Note

See the note for nssuControlGetDownloadedEulaDataSize.

Only available on [4.0.0+].

Parameters

	c	NsSystemUpdateControl
[in]	path	EulaData path.
[out]	buffer	Output buffer.
[in]	size	Size of the output buffer, must be at least the output size from nssuControlGetReceivedEulaDataSize.
[out]	filesize	Output filesize.

nssuControlGetReceivedEulaDataSize()

Result nssuControlGetReceivedEulaDataSize	(	NsSystemUpdateControl *	c,
		const char *	path,
		u64 *	filesize
	)

Gets the filesize for the specified ReceivedEulaData.

Note

See the note for nssuControlGetDownloadedEulaDataSize.

Only available on [4.0.0+].

Parameters

	c	NsSystemUpdateControl
[in]	path	EulaData path.
[out]	filesize	Output filesize.

nssuControlGetReceiveProgress()

Result nssuControlGetReceiveProgress	(	NsSystemUpdateControl *	c,
		NsSystemUpdateProgress *	out
	)

GetReceiveProgress.

Note

Only available on [4.0.0+].

Parameters

	c	NsSystemUpdateControl
[out]	out	NsSystemUpdateProgress

nssuControlHasDownloaded()

Result nssuControlHasDownloaded	(	NsSystemUpdateControl *	c,
		bool *	out
	)

Gets whether a network sysupdate was downloaded, with install pending.

Parameters

	c	NsSystemUpdateControl
[out]	out	Output flag.

nssuControlHasPreparedCardUpdate()

Result nssuControlHasPreparedCardUpdate	(	NsSystemUpdateControl *	c,
		bool *	out
	)

HasPreparedCardUpdate.

Note

nssuControlSetupCardUpdate / nssuControlSetupCardUpdateViaSystemUpdater must have been used at some point prior to using this.

Parameters

	c	NsSystemUpdateControl
[out]	out	Output flag.

nssuControlHasReceived()

Result nssuControlHasReceived	(	NsSystemUpdateControl *	c,
		bool *	out
	)

HasReceived.

Note

Only available on [4.0.0+].

Parameters

	c	NsSystemUpdateControl
[out]	out	Output flag.

nssuControlRequestCheckLatestUpdate()

Result nssuControlRequestCheckLatestUpdate	(	NsSystemUpdateControl *	c,
		AsyncValue *	a
	)

RequestCheckLatestUpdate.

Parameters

	c	NsSystemUpdateControl
[out]	a	AsyncValue. The data that can be read from this is u8 NsLatestSystemUpdate.

nssuControlRequestCheckLatestUpdateIncludesRebootlessUpdate()

Result nssuControlRequestCheckLatestUpdateIncludesRebootlessUpdate	(	NsSystemUpdateControl *	c,
		AsyncValue *	a
	)

RequestCheckLatestUpdateIncludesRebootlessUpdate.

Note

Only available on [6.0.0+].

Parameters

	c	NsSystemUpdateControl
[out]	a	AsyncValue

nssuControlRequestDownloadLatestUpdate()

Result nssuControlRequestDownloadLatestUpdate	(	NsSystemUpdateControl *	c,
		AsyncResult *	a
	)

RequestDownloadLatestUpdate.

Parameters

	c	NsSystemUpdateControl
[out]	a	AsyncResult

nssuControlRequestPrepareCardUpdate()

Result nssuControlRequestPrepareCardUpdate	(	NsSystemUpdateControl *	c,
		AsyncResult *	a
	)

RequestPrepareCardUpdate.

Parameters

	c	NsSystemUpdateControl
[out]	a	AsyncResult

nssuControlRequestReceiveSystemUpdate()

Result nssuControlRequestReceiveSystemUpdate	(	NsSystemUpdateControl *	c,
		AsyncResult *	a,
		u32	addr,
		u16	port,
		NsSystemDeliveryInfo *	info
	)

RequestReceiveSystemUpdate.

Note

The system will use the input addr/port with connect(). addr/port are little-endian.

Only available on [4.0.0+].

Parameters

	c	NsSystemUpdateControl
[out]	a	AsyncResult
[in]	addr	Server IPv4 address. qlaunch uses a local-WLAN addr, however this can be any addr.
[in]	port	Socket port. qlaunch uses value 55556.
[in]	info	NsSystemDeliveryInfo

nssuControlSetupCardUpdate()

Result nssuControlSetupCardUpdate	(	NsSystemUpdateControl *	c,
		void *	buffer,
		size_t	size
	)

SetupCardUpdate.

Parameters

	c	NsSystemUpdateControl
[in]	buffer	TransferMemory buffer, when NULL this is automatically allocated.
[in]	size	TransferMemory buffer size, see NSSU_CARDUPDATE_TMEM_SIZE_DEFAULT.

nssuControlSetupCardUpdateViaSystemUpdater()

Result nssuControlSetupCardUpdateViaSystemUpdater	(	NsSystemUpdateControl *	c,
		void *	buffer,
		size_t	size
	)

SetupCardUpdateViaSystemUpdater.

Note

Same as nssuControlSetupCardUpdate, except this doesn't run the code for fs cmds GetGameCardHandle/GetGameCardUpdatePartitionInfo, and uses fs OpenRegisteredUpdatePartition instead of OpenGameCardFileSystem.

Only available on [4.0.0+].

Parameters

	c	NsSystemUpdateControl
[in]	buffer	TransferMemory buffer, when NULL this is automatically allocated.
[in]	size	TransferMemory buffer size, see NSSU_CARDUPDATE_TMEM_SIZE_DEFAULT.

nssuControlSetupToReceiveSystemUpdate()

Result nssuControlSetupToReceiveSystemUpdate

(

NsSystemUpdateControl *

c

)

Does setup for ReceiveSystemUpdate by using the same nim cmds as nssuDestroySystemUpdateTask.

Note

qlaunch uses this before nssuControlRequestReceiveSystemUpdate.

Only available on [4.0.0+].

Parameters

c	NsSystemUpdateControl

nssuDestroySystemUpdateTask()

Result nssuDestroySystemUpdateTask

(

void

)

This uses nim ListSystemUpdateTask, then when a task is returned uses it with DestroySystemUpdateTask.

Note

Only available on [4.0.0+].

nssuGetBackgroundNetworkUpdateState()

Result nssuGetBackgroundNetworkUpdateState

(

NsBackgroundNetworkUpdateState *

out

)

Gets the NsBackgroundNetworkUpdateState.

Note

Internally this uses nim commands ListSystemUpdateTask and GetSystemUpdateTaskInfo to determine the output state.

Parameters

[out]

out

NsBackgroundNetworkUpdateState

nssuGetSendSystemUpdateProgress()

Result nssuGetSendSystemUpdateProgress

(

NsSystemUpdateProgress *

out

)

GetSendSystemUpdateProgress.

Note

Only available on [4.0.0+].

Parameters

[out]

out

NsSystemUpdateProgress

nssuGetSystemUpdateNotificationEventForContentDelivery()

Result nssuGetSystemUpdateNotificationEventForContentDelivery

(

Event *

out_event

)

Gets an Event which can be signaled by nssuNotifySystemUpdateForContentDelivery.

Note

The Event must be closed by the user once finished with it.

Parameters

[out]

out_event

Output Event with autoclear=false.

nssuNotifyBackgroundNetworkUpdate()

Result nssuNotifyBackgroundNetworkUpdate

(

const NcmContentMetaKey *

key

)

This checks whether a sysupdate is needed with the input NcmContentMetaKey using NCM commands, if not this will just return 0.

Otherwise, this will then run code which is identical to nssuRequestBackgroundNetworkUpdate.

Note

Only usable when a NsSystemUpdateControl isn't open.

Parameters

[in]

key

NcmContentMetaKey

nssuNotifyExFatDriverRequired()

Result nssuNotifyExFatDriverRequired

(

void

)

Uses nim ListSystemUpdateTask, then uses the task with DestroySystemUpdateTask if it exists.

Then this runs ExFat handling, updates state, and sets the same state flag as nssuRequestBackgroundNetworkUpdate.

Note

Only usable when a NsSystemUpdateControl isn't open.

nssuOpenSystemUpdateControl()

Result nssuOpenSystemUpdateControl

(

NsSystemUpdateControl *

c

)

Opens a NsSystemUpdateControl.

Note

Only 1 NsSystemUpdateControl can be open at a time.

Parameters

[out]

c

NsSystemUpdateControl

nssuPrepareShutdown()

Result nssuPrepareShutdown

(

void

)

This does shutdown preparation.

Note

This is used by am-sysmodule, so generally there's no need to use this.

Only available on [3.0.0+].

nssuRequestBackgroundNetworkUpdate()

Result nssuRequestBackgroundNetworkUpdate

(

void

)

RequestBackgroundNetworkUpdate.

Note

Only usable when a NsSystemUpdateControl isn't open.

nssuRequestSendSystemUpdate()

Result nssuRequestSendSystemUpdate	(	AsyncResult *	a,
		u32	addr,
		u16	port,
		NsSystemDeliveryInfo *	info
	)

RequestSendSystemUpdate.

Note

The system will use the input addr/port with bind(), the input addr will eventually be validated with the addr from accept(). addr/port are little-endian.

After the system accepts a connection etc, an error will be thrown if the system is Internet-connected.

Only available on [4.0.0+].

Parameters

[out]	a	AsyncResult
[in]	addr	Client IPv4 address. qlaunch uses a local-WLAN addr.
[in]	port	Socket port. qlaunch uses value 55556.
[in]	info	NsSystemDeliveryInfo

nsTouchApplication()

Result nsTouchApplication

(

u64

application_id

)

TouchApplication.

Note

Only available on [2.0.0+].

Parameters

[in]

application_id

ApplicationId.

nsTriggerDynamicCommitEvent()

Result nsTriggerDynamicCommitEvent

(

void

)

TriggerDynamicCommitEvent.

Note

Only available on [4.0.0+].

nsTryCommitCurrentApplicationDownloadTask()

Result nsTryCommitCurrentApplicationDownloadTask

(

void

)

TryCommitCurrentApplicationDownloadTask.

Note

Only available on [4.0.0+].

nsUnregisterNetworkServiceAccount()

Result nsUnregisterNetworkServiceAccount

(

AccountUid

uid

)

UnregisterNetworkServiceAccount.

Parameters

[in]

uid

AccountUid

nsUnregisterNetworkServiceAccountWithUserSaveDataDeletion()

Result nsUnregisterNetworkServiceAccountWithUserSaveDataDeletion

(

AccountUid

uid

)

UnregisterNetworkServiceAccountWithUserSaveDataDeletion.

Note

Only available on [6.0.0+].

Parameters

[in]

uid

AccountUid

nsVerifyDeliveryProtocolVersion()

Result nsVerifyDeliveryProtocolVersion

(

const NsSystemDeliveryInfo *

info

)

VerifyDeliveryProtocolVersion.

Note

Only available on [4.0.0+].

Parameters

[in]

info

NsSystemDeliveryInfo

nsWithdrawApplicationUpdateRequest()

Result nsWithdrawApplicationUpdateRequest

(

u64

application_id

)

WithdrawApplicationUpdateRequest.

Note

Only available on [2.0.0+].

Parameters

[in]

application_id

ApplicationId.