libnx  v4.2.0
Data Structures | Macros | Typedefs | Enumerations
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.
 
ServicensGetServiceSession_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.
 
ServicensGetServiceSession_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. More...
 
Result nsGetReadOnlyApplicationControlDataInterface (Service *srv_out)
 Gets the Service object for IReadOnlyApplicationControlDataInterface via the cmd for that. More...
 
Result nsGetReadOnlyApplicationRecordInterface (Service *srv_out)
 Gets the Service object for IReadOnlyApplicationRecordInterface via the cmd for that. More...
 
Result nsGetECommerceInterface (Service *srv_out)
 Gets the Service object for IECommerceInterface via the cmd for that. More...
 
Result nsGetApplicationVersionInterface (Service *srv_out)
 Gets the Service object for IApplicationVersionInterface via the cmd for that. More...
 
Result nsGetFactoryResetInterface (Service *srv_out)
 Gets the Service object for IFactoryResetInterface via the cmd for that. More...
 
Result nsGetAccountProxyInterface (Service *srv_out)
 Gets the Service object for IAccountProxyInterface via the cmd for that. More...
 
Result nsGetApplicationManagerInterface (Service *srv_out)
 Gets the Service object for IApplicationManagerInterface via the cmd for that. More...
 
Result nsGetDownloadTaskInterface (Service *srv_out)
 Gets the Service object for IDownloadTaskInterface via the cmd for that. More...
 
Result nsGetContentManagementInterface (Service *srv_out)
 Gets the Service object for IContentManagementInterface via the cmd for that. More...
 
Result nsGetDocumentInterface (Service *srv_out)
 Gets the Service object for IDocumentInterface via the cmd for that. More...
 
IReadOnlyApplicationControlDataInterface
Result nsGetApplicationControlData (NsApplicationControlSource source, u64 application_id, NsApplicationControlData *buffer, size_t size, u64 *actual_size)
 Gets the NsApplicationControlData for the specified application. More...
 
Result nsGetApplicationDesiredLanguage (NacpStruct *nacp, NacpLanguageEntry **langentry)
 GetApplicationDesiredLanguage. More...
 
IECommerceInterface
Result nsRequestLinkDevice (AsyncResult *a, AccountUid uid)
 RequestLinkDevice. More...
 
Result nsRequestSyncRights (AsyncResult *a)
 RequestSyncRights. More...
 
Result nsRequestUnlinkDevice (AsyncResult *a, AccountUid uid)
 RequestUnlinkDevice. More...
 
IFactoryResetInterface
Result nsResetToFactorySettings (void)
 ResetToFactorySettings. More...
 
Result nsResetToFactorySettingsWithoutUserSaveData (void)
 ResetToFactorySettingsWithoutUserSaveData. More...
 
Result nsResetToFactorySettingsForRefurbishment (void)
 ResetToFactorySettingsForRefurbishment. More...
 
Result nsResetToFactorySettingsWithPlatformRegion (void)
 ResetToFactorySettingsWithPlatformRegion. More...
 
Result nsResetToFactorySettingsWithPlatformRegionAuthentication (void)
 ResetToFactorySettingsWithPlatformRegionAuthentication. More...
 
IApplicationManagerInterface
Result nsListApplicationRecord (NsApplicationRecord *records, s32 count, s32 entry_offset, s32 *out_entrycount)
 Gets an listing of NsApplicationRecord. More...
 
Result nsGetApplicationRecordUpdateSystemEvent (Event *out_event)
 GetApplicationRecordUpdateSystemEvent. More...
 
Result nsGetApplicationViewDeprecated (NsApplicationViewDeprecated *views, const u64 *application_ids, s32 count)
 GetApplicationViewDeprecated. More...
 
Result nsDeleteApplicationEntity (u64 application_id)
 DeleteApplicationEntity. More...
 
Result nsDeleteApplicationCompletely (u64 application_id)
 DeleteApplicationCompletely. More...
 
Result nsDeleteRedundantApplicationEntity (void)
 DeleteRedundantApplicationEntity.
 
Result nsIsApplicationEntityMovable (u64 application_id, NcmStorageId storage_id, bool *out)
 IsApplicationEntityMovable. More...
 
Result nsMoveApplicationEntity (u64 application_id, NcmStorageId storage_id)
 MoveApplicationEntity. More...
 
Result nsRequestApplicationUpdateInfo (AsyncValue *a, u64 application_id)
 RequestApplicationUpdateInfo. More...
 
Result nsCancelApplicationDownload (u64 application_id)
 CancelApplicationDownload. More...
 
Result nsResumeApplicationDownload (u64 application_id)
 ResumeApplicationDownload. More...
 
Result nsCheckApplicationLaunchVersion (u64 application_id)
 CheckApplicationLaunchVersion. More...
 
Result nsCalculateApplicationDownloadRequiredSize (u64 application_id, NcmStorageId *storage_id, s64 *size)
 CalculateApplicationApplyDeltaRequiredSize. More...
 
Result nsCleanupSdCard (void)
 CleanupSdCard.
 
Result nsGetSdCardMountStatusChangedEvent (Event *out_event)
 GetSdCardMountStatusChangedEvent. More...
 
Result nsGetGameCardUpdateDetectionEvent (Event *out_event)
 GetGameCardUpdateDetectionEvent. More...
 
Result nsDisableApplicationAutoDelete (u64 application_id)
 DisableApplicationAutoDelete. More...
 
Result nsEnableApplicationAutoDelete (u64 application_id)
 EnableApplicationAutoDelete. More...
 
Result nsSetApplicationTerminateResult (u64 application_id, Result res)
 SetApplicationTerminateResult. More...
 
Result nsClearApplicationTerminateResult (u64 application_id)
 ClearApplicationTerminateResult. More...
 
Result nsGetLastSdCardMountUnexpectedResult (void)
 GetLastSdCardMountUnexpectedResult.
 
Result nsGetRequestServerStopper (NsRequestServerStopper *r)
 Opens a NsRequestServerStopper. More...
 
Result nsCancelApplicationApplyDelta (u64 application_id)
 CancelApplicationApplyDelta. More...
 
Result nsResumeApplicationApplyDelta (u64 application_id)
 ResumeApplicationApplyDelta. More...
 
Result nsCalculateApplicationApplyDeltaRequiredSize (u64 application_id, NcmStorageId *storage_id, s64 *size)
 CalculateApplicationApplyDeltaRequiredSize. More...
 
Result nsResumeAll (void)
 ResumeAll. More...
 
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. More...
 
Result nsRequestUpdateApplication2 (AsyncResult *a, u64 application_id)
 RequestUpdateApplication2. More...
 
Result nsDeleteUserSaveDataAll (NsProgressMonitorForDeleteUserSaveDataAll *p, AccountUid uid)
 DeleteUserSaveDataAll. More...
 
Result nsDeleteUserSystemSaveData (AccountUid uid, u64 system_save_data_id)
 DeleteUserSystemSaveData. More...
 
Result nsDeleteSaveData (FsSaveDataSpaceId save_data_space_id, u64 save_data_id)
 DeleteSaveData. More...
 
Result nsUnregisterNetworkServiceAccount (AccountUid uid)
 UnregisterNetworkServiceAccount. More...
 
Result nsUnregisterNetworkServiceAccountWithUserSaveDataDeletion (AccountUid uid)
 UnregisterNetworkServiceAccountWithUserSaveDataDeletion. More...
 
Result nsRequestDownloadApplicationControlData (AsyncResult *a, u64 application_id)
 RequestDownloadApplicationControlData. More...
 
Result nsListApplicationTitle (AsyncValue *a, NsApplicationControlSource source, const u64 *application_ids, s32 count, void *buffer, size_t size)
 ListApplicationTitle. More...
 
Result nsListApplicationIcon (AsyncValue *a, NsApplicationControlSource source, const u64 *application_ids, s32 count, void *buffer, size_t size)
 ListApplicationIcon. More...
 
Result nsRequestCheckGameCardRegistration (AsyncResult *a, u64 application_id)
 RequestCheckGameCardRegistration. More...
 
Result nsRequestGameCardRegistrationGoldPoint (AsyncValue *a, AccountUid uid, u64 application_id)
 RequestGameCardRegistrationGoldPoint. More...
 
Result nsRequestRegisterGameCard (AsyncResult *a, AccountUid uid, u64 application_id, s32 inval)
 RequestRegisterGameCard. More...
 
Result nsGetGameCardMountFailureEvent (Event *out_event)
 GetGameCardMountFailureEvent. More...
 
Result nsIsGameCardInserted (bool *out)
 IsGameCardInserted. More...
 
Result nsEnsureGameCardAccess (void)
 EnsureGameCardAccess. More...
 
Result nsGetLastGameCardMountFailureResult (void)
 GetLastGameCardMountFailureResult. More...
 
Result nsListApplicationIdOnGameCard (u64 *application_ids, s32 count, s32 *total_out)
 ListApplicationIdOnGameCard. More...
 
Result nsTouchApplication (u64 application_id)
 TouchApplication. More...
 
Result nsIsApplicationUpdateRequested (u64 application_id, bool *flag, u32 *out)
 IsApplicationUpdateRequested. More...
 
Result nsWithdrawApplicationUpdateRequest (u64 application_id)
 WithdrawApplicationUpdateRequest. More...
 
Result nsRequestVerifyAddOnContentsRights (NsProgressAsyncResult *a, u64 application_id)
 RequestVerifyAddOnContentsRights. More...
 
Result nsRequestVerifyApplication (NsProgressAsyncResult *a, u64 application_id, u32 unk, void *buffer, size_t size)
 RequestVerifyApplication. More...
 
Result nsIsAnyApplicationEntityInstalled (u64 application_id, bool *out)
 IsAnyApplicationEntityInstalled. More...
 
Result nsCleanupUnavailableAddOnContents (u64 application_id, AccountUid uid)
 CleanupUnavailableAddOnContents. More...
 
Result nsFormatSdCard (void)
 FormatSdCard. More...
 
Result nsNeedsSystemUpdateToFormatSdCard (bool *out)
 NeedsSystemUpdateToFormatSdCard. More...
 
Result nsGetLastSdCardFormatUnexpectedResult (void)
 GetLastSdCardFormatUnexpectedResult. More...
 
Result nsGetApplicationView (NsApplicationView *views, const u64 *application_ids, s32 count)
 GetApplicationView. More...
 
Result nsGetApplicationViewDownloadErrorContext (u64 application_id, ErrorContext *context)
 GetApplicationViewDownloadErrorContext. More...
 
Result nsGetApplicationViewWithPromotionInfo (NsApplicationViewWithPromotionInfo *out, const u64 *application_ids, s32 count)
 GetApplicationViewWithPromotionInfo. More...
 
Result nsRequestDownloadApplicationPrepurchasedRights (AsyncResult *a, u64 application_id)
 RequestDownloadApplicationPrepurchasedRights. More...
 
Result nsGetSystemDeliveryInfo (NsSystemDeliveryInfo *info)
 Generates a NsSystemDeliveryInfo using the currently installed SystemUpdate meta. More...
 
Result nsSelectLatestSystemDeliveryInfo (const NsSystemDeliveryInfo *sys_list, s32 sys_count, const NsSystemDeliveryInfo *base_info, const NsApplicationDeliveryInfo *app_list, s32 app_count, s32 *index)
 SelectLatestSystemDeliveryInfo. More...
 
Result nsVerifyDeliveryProtocolVersion (const NsSystemDeliveryInfo *info)
 VerifyDeliveryProtocolVersion. More...
 
Result nsGetApplicationDeliveryInfo (NsApplicationDeliveryInfo *info, s32 count, u64 application_id, u32 attr, s32 *total_out)
 Generates NsApplicationDeliveryInfo for the specified ApplicationId. More...
 
Result nsHasAllContentsToDeliver (const NsApplicationDeliveryInfo *info, s32 count, bool *out)
 HasAllContentsToDeliver. More...
 
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. More...
 
Result nsCanDeliverApplication (const NsApplicationDeliveryInfo *info0, s32 count0, const NsApplicationDeliveryInfo *info1, s32 count1, bool *out)
 CanDeliverApplication. More...
 
Result nsListContentMetaKeyToDeliverApplication (NcmContentMetaKey *meta, s32 meta_count, s32 meta_index, const NsApplicationDeliveryInfo *info, s32 info_count, s32 *total_out)
 ListContentMetaKeyToDeliverApplication. More...
 
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. More...
 
Result nsEstimateRequiredSize (const NcmContentMetaKey *meta, s32 count, s64 *out)
 EstimateRequiredSize. More...
 
Result nsRequestReceiveApplication (AsyncResult *a, u32 addr, u16 port, u64 application_id, const NcmContentMetaKey *meta, s32 count, NcmStorageId storage_id)
 RequestReceiveApplication. More...
 
Result nsCommitReceiveApplication (u64 application_id)
 CommitReceiveApplication. More...
 
Result nsGetReceiveApplicationProgress (u64 application_id, NsReceiveApplicationProgress *out)
 GetReceiveApplicationProgress. More...
 
Result nsRequestSendApplication (AsyncResult *a, u32 addr, u16 port, u64 application_id, const NcmContentMetaKey *meta, s32 count)
 RequestSendApplication. More...
 
Result nsGetSendApplicationProgress (u64 application_id, NsSendApplicationProgress *out)
 GetSendApplicationProgress. More...
 
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. More...
 
Result nsListNotCommittedContentMeta (NcmContentMetaKey *meta, s32 count, u64 application_id, s32 unk, s32 *total_out)
 ListNotCommittedContentMeta. More...
 
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. More...
 
Result nsGetApplicationTerminateResult (u64 application_id, Result *res)
 GetApplicationTerminateResult. More...
 
Result nsGetApplicationRightsOnClient (NsApplicationRightsOnClient *rights, s32 count, u64 application_id, AccountUid uid, u32 flags, s32 *total_out)
 GetApplicationRightsOnClient. More...
 
Result nsRequestNoDownloadRightsErrorResolution (AsyncValue *a, u64 application_id)
 RequestNoDownloadRightsErrorResolution. More...
 
Result nsRequestResolveNoDownloadRightsError (AsyncValue *a, u64 application_id)
 RequestResolveNoDownloadRightsError. More...
 
Result nsGetPromotionInfo (NsPromotionInfo *promotion, u64 application_id, AccountUid uid)
 GetPromotionInfo. More...
 
IDownloadTaskInterface
Result nsClearTaskStatusList (void)
 ClearTaskStatusList. More...
 
Result nsRequestDownloadTaskList (void)
 RequestDownloadTaskList. More...
 
Result nsRequestEnsureDownloadTask (AsyncResult *a)
 RequestEnsureDownloadTask. More...
 
Result nsListDownloadTaskStatus (NsDownloadTaskStatus *tasks, s32 count, s32 *total_out)
 ListDownloadTaskStatus. More...
 
Result nsRequestDownloadTaskListData (AsyncValue *a)
 RequestDownloadTaskListData. More...
 
Result nsTryCommitCurrentApplicationDownloadTask (void)
 TryCommitCurrentApplicationDownloadTask. More...
 
Result nsEnableAutoCommit (void)
 EnableAutoCommit. More...
 
Result nsDisableAutoCommit (void)
 DisableAutoCommit. More...
 
Result nsTriggerDynamicCommitEvent (void)
 TriggerDynamicCommitEvent. More...
 
IContentManagementInterface
Result nsCalculateApplicationOccupiedSize (u64 application_id, NsApplicationOccupiedSize *out)
 CalculateApplicationOccupiedSize. More...
 
Result nsCheckSdCardMountStatus (void)
 CheckSdCardMountStatus. More...
 
Result nsGetTotalSpaceSize (NcmStorageId storage_id, s64 *size)
 Returns the total storage capacity (used + free) from content manager services. More...
 
Result nsGetFreeSpaceSize (NcmStorageId storage_id, s64 *size)
 Returns the available storage capacity from content manager services. More...
 
Result nsCountApplicationContentMeta (u64 application_id, s32 *out)
 CountApplicationContentMeta. More...
 
Result nsListApplicationContentMetaStatus (u64 application_id, s32 index, NsApplicationContentMetaStatus *list, s32 count, s32 *out_entrycount)
 Gets an listing of NsApplicationContentMetaStatus. More...
 
Result nsIsAnyApplicationRunning (bool *out)
 IsAnyApplicationRunning. More...
 
IRequestServerStopper
void nsRequestServerStopperClose (NsRequestServerStopper *r)
 Close a NsRequestServerStopper. More...
 
IProgressMonitorForDeleteUserSaveDataAll
Result nsProgressMonitorForDeleteUserSaveDataAllClose (NsProgressMonitorForDeleteUserSaveDataAll *p)
 Close a NsProgressMonitorForDeleteUserSaveDataAll. More...
 
Result nsProgressMonitorForDeleteUserSaveDataAllGetSystemEvent (NsProgressMonitorForDeleteUserSaveDataAll *p, Event *out_event)
 GetSystemEvent. More...
 
Result nsProgressMonitorForDeleteUserSaveDataAllIsFinished (NsProgressMonitorForDeleteUserSaveDataAll *p, bool *out)
 IsFinished. More...
 
Result nsProgressMonitorForDeleteUserSaveDataAllGetResult (NsProgressMonitorForDeleteUserSaveDataAll *p)
 GetResult. More...
 
Result nsProgressMonitorForDeleteUserSaveDataAllGetProgress (NsProgressMonitorForDeleteUserSaveDataAll *p, NsProgressForDeleteUserSaveDataAll *progress)
 GetProgress. More...
 
IProgressAsyncResult
void nsProgressAsyncResultClose (NsProgressAsyncResult *a)
 Close a NsProgressAsyncResult. More...
 
Result nsProgressAsyncResultWait (NsProgressAsyncResult *a, u64 timeout)
 Waits for the async operation to finish using the specified timeout. More...
 
Result nsProgressAsyncResultGet (NsProgressAsyncResult *a)
 Gets the Result. More...
 
Result nsProgressAsyncResultCancel (NsProgressAsyncResult *a)
 Cancels the async operation. More...
 
Result nsProgressAsyncResultGetProgress (NsProgressAsyncResult *a, void *buffer, size_t size)
 Gets the progress. More...
 
Result nsProgressAsyncResultGetDetailResult (NsProgressAsyncResult *a)
 GetDetailResult. More...
 
Result nsProgressAsyncResultGetErrorContext (NsProgressAsyncResult *a, ErrorContext *context)
 Gets the ErrorContext. More...
 
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.
 
ServicensvmGetServiceSession (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.
 
ServicensdevGetServiceSession (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+]
 
Result nsdevLaunchApplicationWithStorageIdForDevelop (u64 *out_pid, u64 application_id, u32 flags, u8 app_storage_id, u8 patch_storage_id)
 
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.
 
ServicenssuGetServiceSession (void)
 Gets the Service object for ns:su.
 
Result nssuGetBackgroundNetworkUpdateState (NsBackgroundNetworkUpdateState *out)
 Gets the NsBackgroundNetworkUpdateState. More...
 
Result nssuOpenSystemUpdateControl (NsSystemUpdateControl *c)
 Opens a NsSystemUpdateControl. More...
 
Result nssuNotifyExFatDriverRequired (void)
 Uses nim ListSystemUpdateTask, then uses the task with DestroySystemUpdateTask if it exists. More...
 
Result nssuClearExFatDriverStatusForDebug (void)
 ClearExFatDriverStatusForDebug.
 
Result nssuRequestBackgroundNetworkUpdate (void)
 RequestBackgroundNetworkUpdate. More...
 
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. More...
 
Result nssuNotifyExFatDriverDownloadedForDebug (void)
 NotifyExFatDriverDownloadedForDebug.
 
Result nssuGetSystemUpdateNotificationEventForContentDelivery (Event *out_event)
 Gets an Event which can be signaled by nssuNotifySystemUpdateForContentDelivery. More...
 
Result nssuNotifySystemUpdateForContentDelivery (void)
 Signals the event returned by nssuGetSystemUpdateNotificationEventForContentDelivery.
 
Result nssuPrepareShutdown (void)
 This does shutdown preparation. More...
 
Result nssuDestroySystemUpdateTask (void)
 This uses nim ListSystemUpdateTask, then when a task is returned uses it with DestroySystemUpdateTask. More...
 
Result nssuRequestSendSystemUpdate (AsyncResult *a, u32 addr, u16 port, NsSystemDeliveryInfo *info)
 RequestSendSystemUpdate. More...
 
Result nssuGetSendSystemUpdateProgress (NsSystemUpdateProgress *out)
 GetSendSystemUpdateProgress. More...
 
ISystemUpdateControl
void nssuControlClose (NsSystemUpdateControl *c)
 Close a NsSystemUpdateControl. More...
 
Result nssuControlHasDownloaded (NsSystemUpdateControl *c, bool *out)
 Gets whether a network sysupdate was downloaded, with install pending. More...
 
Result nssuControlRequestCheckLatestUpdate (NsSystemUpdateControl *c, AsyncValue *a)
 RequestCheckLatestUpdate. More...
 
Result nssuControlRequestDownloadLatestUpdate (NsSystemUpdateControl *c, AsyncResult *a)
 RequestDownloadLatestUpdate. More...
 
Result nssuControlGetDownloadProgress (NsSystemUpdateControl *c, NsSystemUpdateProgress *out)
 GetDownloadProgress. More...
 
Result nssuControlApplyDownloadedUpdate (NsSystemUpdateControl *c)
 ApplyDownloadedUpdate. More...
 
Result nssuControlRequestPrepareCardUpdate (NsSystemUpdateControl *c, AsyncResult *a)
 RequestPrepareCardUpdate. More...
 
Result nssuControlGetPrepareCardUpdateProgress (NsSystemUpdateControl *c, NsSystemUpdateProgress *out)
 GetPrepareCardUpdateProgress. More...
 
Result nssuControlHasPreparedCardUpdate (NsSystemUpdateControl *c, bool *out)
 HasPreparedCardUpdate. More...
 
Result nssuControlApplyCardUpdate (NsSystemUpdateControl *c)
 ApplyCardUpdate. More...
 
Result nssuControlGetDownloadedEulaDataSize (NsSystemUpdateControl *c, const char *path, u64 *filesize)
 Gets the filesize for the specified DownloadedEulaData. More...
 
Result nssuControlGetDownloadedEulaData (NsSystemUpdateControl *c, const char *path, void *buffer, size_t size, u64 *filesize)
 Gets the specified DownloadedEulaData. More...
 
Result nssuControlSetupCardUpdate (NsSystemUpdateControl *c, void *buffer, size_t size)
 SetupCardUpdate. More...
 
Result nssuControlGetPreparedCardUpdateEulaDataSize (NsSystemUpdateControl *c, const char *path, u64 *filesize)
 Gets the filesize for the specified PreparedCardUpdateEulaData. More...
 
Result nssuControlGetPreparedCardUpdateEulaData (NsSystemUpdateControl *c, const char *path, void *buffer, size_t size, u64 *filesize)
 Gets the specified PreparedCardUpdateEulaData. More...
 
Result nssuControlSetupCardUpdateViaSystemUpdater (NsSystemUpdateControl *c, void *buffer, size_t size)
 SetupCardUpdateViaSystemUpdater. More...
 
Result nssuControlHasReceived (NsSystemUpdateControl *c, bool *out)
 HasReceived. More...
 
Result nssuControlRequestReceiveSystemUpdate (NsSystemUpdateControl *c, AsyncResult *a, u32 addr, u16 port, NsSystemDeliveryInfo *info)
 RequestReceiveSystemUpdate. More...
 
Result nssuControlGetReceiveProgress (NsSystemUpdateControl *c, NsSystemUpdateProgress *out)
 GetReceiveProgress. More...
 
Result nssuControlApplyReceivedUpdate (NsSystemUpdateControl *c)
 ApplyReceivedUpdate. More...
 
Result nssuControlGetReceivedEulaDataSize (NsSystemUpdateControl *c, const char *path, u64 *filesize)
 Gets the filesize for the specified ReceivedEulaData. More...
 
Result nssuControlGetReceivedEulaData (NsSystemUpdateControl *c, const char *path, void *buffer, size_t size, u64 *filesize)
 Gets the specified ReceivedEulaData. More...
 
Result nssuControlSetupToReceiveSystemUpdate (NsSystemUpdateControl *c)
 Does setup for ReceiveSystemUpdate by using the same nim cmds as nssuDestroySystemUpdateTask. More...
 
Result nssuControlRequestCheckLatestUpdateIncludesRebootlessUpdate (NsSystemUpdateControl *c, AsyncValue *a)
 RequestCheckLatestUpdateIncludesRebootlessUpdate. More...
 

Detailed Description

NS services IPC wrapper.

Author
yellows8

Enumeration Type Documentation

◆ 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

BackgroundNetworkUpdateState.

Enumerator
NsBackgroundNetworkUpdateState_None 

No sysupdate task exists.

NsBackgroundNetworkUpdateState_Downloading 

Sysupdate download in progress.

NsBackgroundNetworkUpdateState_Ready 

Sysupdate ready, pending install.

◆ NsLatestSystemUpdate

LatestSystemUpdate.

Enumerator
NsLatestSystemUpdate_Unknown0 

Unknown.

NsLatestSystemUpdate_Unknown1 

Unknown.

NsLatestSystemUpdate_Unknown2 

Unknown.

◆ 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_idApplicationId.
[out]storage_idOutput NcmStorageId.
[out]sizeOutput size.

◆ nsCalculateApplicationDownloadRequiredSize()

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

CalculateApplicationApplyDeltaRequiredSize.

Parameters
[in]application_idApplicationId.
[out]storage_idOutput NcmStorageId.
[out]sizeOutput size.

◆ nsCalculateApplicationOccupiedSize()

Result nsCalculateApplicationOccupiedSize ( u64  application_id,
NsApplicationOccupiedSize out 
)

CalculateApplicationOccupiedSize.

Note
Uses nsGetContentManagementInterface on [3.0.0+], otherwise IApplicationManagerInterface is used.
Parameters
[in]application_idApplicationId.
[out]outNsApplicationOccupiedSize

◆ nsCancelApplicationApplyDelta()

Result nsCancelApplicationApplyDelta ( u64  application_id)

CancelApplicationApplyDelta.

Note
Only available on [3.0.0+].
Parameters
[in]application_idApplicationId.

◆ nsCancelApplicationDownload()

Result nsCancelApplicationDownload ( u64  application_id)

CancelApplicationDownload.

Parameters
[in]application_idApplicationId.

◆ 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]info0First input array of NsApplicationDeliveryInfo.
[in]count0Size of the info0 array in entries. Must be value <=1, when 0 this will return 0 with out set to 0.
[in]info1Second input array of NsApplicationDeliveryInfo.
[in]count1Size of the info1 array in entries. Must be value 1.
[out]outOutput flag.

◆ nsCheckApplicationLaunchVersion()

Result nsCheckApplicationLaunchVersion ( u64  application_id)

CheckApplicationLaunchVersion.

Parameters
[in]application_idApplicationId.

◆ 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_idApplicationId.
[in]uidAccountUid

◆ nsClearApplicationTerminateResult()

Result nsClearApplicationTerminateResult ( u64  application_id)

ClearApplicationTerminateResult.

Parameters
[in]application_idApplicationId.

◆ 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_idApplicationId

◆ 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]info0First input array of NsApplicationDeliveryInfo.
[in]count0Size of the info0 array in entries. Must be value 1.
[in]info1Second input array of NsApplicationDeliveryInfo.
[in]count1Size of the info1 array in entries. Must be value 1.
[out]outComparison 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]info0First NsSystemDeliveryInfo.
[in]info1Second NsSystemDeliveryInfo.
[out]outComparison 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_idApplicationId.
[out]outOutput count.

◆ nsDeleteApplicationCompletely()

Result nsDeleteApplicationCompletely ( u64  application_id)

DeleteApplicationCompletely.

Parameters
[in]application_idApplicationId.

◆ nsDeleteApplicationEntity()

Result nsDeleteApplicationEntity ( u64  application_id)

DeleteApplicationEntity.

Parameters
[in]application_idApplicationId.

◆ 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_idFsSaveDataSpaceId
[in]save_data_idSaveDataId

◆ nsDeleteUserSaveDataAll()

Result nsDeleteUserSaveDataAll ( NsProgressMonitorForDeleteUserSaveDataAll p,
AccountUid  uid 
)

DeleteUserSaveDataAll.

Parameters
[in]pNsProgressMonitorForDeleteUserSaveDataAll
[in]uidAccountUid

◆ nsDeleteUserSystemSaveData()

Result nsDeleteUserSystemSaveData ( AccountUid  uid,
u64  system_save_data_id 
)

DeleteUserSystemSaveData.

Parameters
[in]uidAccountUid
[in]system_save_data_idSystemSaveDataId

◆ nsDisableApplicationAutoDelete()

Result nsDisableApplicationAutoDelete ( u64  application_id)

DisableApplicationAutoDelete.

Parameters
[in]application_idApplicationId.

◆ nsDisableAutoCommit()

Result nsDisableAutoCommit ( void  )

DisableAutoCommit.

Note
Only available on [4.0.0+].

◆ nsEnableApplicationAutoDelete()

Result nsEnableApplicationAutoDelete ( u64  application_id)

EnableApplicationAutoDelete.

Parameters
[in]application_idApplicationId.

◆ 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]metaInput array of NcmContentMetaKey.
[in]countSize of the meta array in entries. When less than 1, this will return 0 with out set to 0.
[out]outOutput size.

◆ 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]sourceSource, official sw uses NsApplicationControlSource_Storage.
[in]application_idApplicationId.
[out]bufferNsApplicationControlData
[in]sizeSize of the buffer.
[out]actual_sizeActual 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]infoOutput array of NsApplicationDeliveryInfo.
[in]countSize of the array in entries.
[in]application_idApplicationId
[in]attrApplicationDeliveryAttributeTag bitmask.
[out]total_outTotal 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]infoInput array of NsApplicationDeliveryInfo.
[in]countSize of the array in entries.
[out]out_hashOutput 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]nacpNacpStruct
[out]langentryNacpLanguageEntry

◆ 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_eventOutput 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]rightsOutput array of NsApplicationRightsOnClient.
[in]countSize of the rights array in entries. qlaunch uses value 3 for this.
[in]application_idApplicationId
[in]uidAccountUid, can optionally be all-zero.
[in]flagsFlags. Official sw hard-codes this to value 0x3.
[out]total_outTotal output entries.

◆ nsGetApplicationTerminateResult()

Result nsGetApplicationTerminateResult ( u64  application_id,
Result res 
)

GetApplicationTerminateResult.

Note
Only available on [6.0.0+].
Parameters
[in]application_idApplicationId.
[out]resOutput 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]outOutput array of NsApplicationView.
[in]application_idsInput array of ApplicationIds.
[in]countSize 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]outOutput array of NsApplicationViewDeprecated.
[in]application_idsInput array of ApplicationIds.
[in]countSize 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_idApplicationId
[out]contextErrorContext

◆ nsGetApplicationViewWithPromotionInfo()

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

GetApplicationViewWithPromotionInfo.

Note
Only available on [8.0.0+].
Parameters
[out]outOutput array of NsApplicationViewWithPromotionInfo.
[in]application_idsInput array of ApplicationIds.
[in]countSize 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_idNcmStorageId. Must be NcmStorageId_SdCard.
[out]sizePointer 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_eventOutput 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_eventOutput 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]promotionNsPromotionInfo
application_idApplicationId.
[in]uidAccountUid

◆ 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_idApplicationId
[out]outNsReceiveApplicationProgress

◆ nsGetRequestServerStopper()

Result nsGetRequestServerStopper ( NsRequestServerStopper r)

Opens a NsRequestServerStopper.

Note
Only available on [2.0.0+].
Parameters
[out]rNsRequestServerStopper

◆ nsGetSdCardMountStatusChangedEvent()

Result nsGetSdCardMountStatusChangedEvent ( Event out_event)

GetSdCardMountStatusChangedEvent.

Note
The Event must be closed by the user once finished with it.
Parameters
[out]out_eventOutput Event with autoclear=false.

◆ nsGetSendApplicationProgress()

Result nsGetSendApplicationProgress ( u64  application_id,
NsSendApplicationProgress out 
)

GetSendApplicationProgress.

Note
Only available on [4.0.0+].
Parameters
[in]application_idApplicationId
[out]outNsSendApplicationProgress

◆ 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_idNcmStorageId, must be NcmStorageId_BuiltInUser or NcmStorageId_SdCard.
[out]total_space_sizeOutput from GetTotalSpaceSize.
[out]free_space_sizeOutput 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]infoNsSystemDeliveryInfo

◆ 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_idNcmStorageId. Must be NcmStorageId_SdCard.
[out]sizePointer 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]infoInput array of NsApplicationDeliveryInfo.
[in]countSize of the array in entries. Must be value 1.
[out]outOutput flag.

◆ nsIsAnyApplicationEntityInstalled()

Result nsIsAnyApplicationEntityInstalled ( u64  application_id,
bool *  out 
)

IsAnyApplicationEntityInstalled.

Note
Only available on [2.0.0+].
Parameters
[in]application_idApplicationId.
[out]outOutput flag.

◆ nsIsAnyApplicationRunning()

Result nsIsAnyApplicationRunning ( bool *  out)

IsAnyApplicationRunning.

Note
Only available on [3.0.0+].
Parameters
[out]outOutput flag.

◆ nsIsApplicationEntityMovable()

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

IsApplicationEntityMovable.

Parameters
[in]application_idApplicationId.
[in]storage_idNcmStorageId
[out]outOutput flag.

◆ nsIsApplicationUpdateRequested()

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

IsApplicationUpdateRequested.

Note
Only available on [2.0.0+].
Parameters
[in]application_idApplicationId.
[out]flagOutput flag, indicating whether out is valid.
[out]outOutput value.

◆ nsIsGameCardInserted()

Result nsIsGameCardInserted ( bool *  out)

IsGameCardInserted.

Note
Only available on [3.0.0+].
Parameters
[out]outOutput 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_idApplicationId.
[in]indexStarting entry index.
[out]listOutput array of NsApplicationContentMetaStatus.
[in]countSize of the list array in entries.
[out]out_entrycountTotal 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]aAsyncValue
[in]sourceSource.
[in]application_idsInput array of ApplicationIds.
[in]countSize of the application_ids array in entries.
buffer0x1000-byte aligned buffer for TransferMemory. This buffer must not be accessed until the async operation finishes.
[in]size0x1000-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_idsOutput array of ApplicationIds.
[in]countSize of the application_ids array in entries.
[out]total_outTotal output entries.

◆ nsListApplicationRecord()

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

Gets an listing of NsApplicationRecord.

Parameters
[out]recordsOutput array of NsApplicationRecord.
[in]countSize of the records array in entries.
[in]entry_offsetStarting entry offset.
[out]out_entrycountTotal 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]aAsyncValue
[in]sourceSource, qlaunch uses NsApplicationControlSource_Storage.
[in]application_idsInput array of ApplicationIds.
[in]countSize of the application_ids array in entries.
buffer0x1000-byte aligned buffer for TransferMemory. This buffer must not be accessed until the async operation finishes.
[in]size0x1000-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]metaOutput array of NcmContentMetaKey.
[in]meta_countSize of the meta array in entries. Must be at least 1, only 1 entry will be returned.
[in]meta_indexMeta entry index. An output NcmContentMetaKey will not be returned when this value is larger than 0.
[in]infoInput array of NsApplicationDeliveryInfo.
[in]info_countSize of the info array in entries. Must be value 1.
[out]total_outTotal 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]tasksOutput array of NsDownloadTaskStatus.
[in]countSize of the tasks array in entries. A maximum of 0x100 tasks can be stored in state.
[out]total_outTotal 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]metaOutput array of NcmContentMetaKey.
[in]countSize of the meta array in entries.
[in]application_idApplicationId
[in]unkUnknown.
[out]total_outTotal 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_idApplicationId.
[in]storage_idNcmStorageId

◆ 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]infoInput array of NsApplicationDeliveryInfo.
[in]countSize of the info array in entries. Must be value 1.
[in]sys_infoNsSystemDeliveryInfo
[out]outOutput flag.

◆ nsNeedsSystemUpdateToFormatSdCard()

Result nsNeedsSystemUpdateToFormatSdCard ( bool *  out)

NeedsSystemUpdateToFormatSdCard.

Note
Only available on [2.0.0+].
Parameters
[out]outOutput flag.

◆ nsProgressAsyncResultCancel()

Result nsProgressAsyncResultCancel ( NsProgressAsyncResult a)

Cancels the async operation.

Note
Used automatically by nsProgressAsyncResultClose.
Parameters
aNsProgressAsyncResult

◆ nsProgressAsyncResultClose()

void nsProgressAsyncResultClose ( NsProgressAsyncResult a)

Close a NsProgressAsyncResult.

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

◆ nsProgressAsyncResultGet()

Result nsProgressAsyncResultGet ( NsProgressAsyncResult a)

Gets the Result.

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

◆ nsProgressAsyncResultGetDetailResult()

Result nsProgressAsyncResultGetDetailResult ( NsProgressAsyncResult a)

GetDetailResult.

Parameters
aNsProgressAsyncResult

◆ nsProgressAsyncResultGetErrorContext()

Result nsProgressAsyncResultGetErrorContext ( NsProgressAsyncResult a,
ErrorContext context 
)

Gets the ErrorContext.

Note
Only available on [4.0.0+].
Parameters
aNsProgressAsyncResult
[out]contextErrorContext

◆ nsProgressAsyncResultGetProgress()

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

Gets the progress.

Parameters
aNsProgressAsyncResult
[out]bufferOutput buffer.
[in]sizeOutput buffer size.

◆ nsProgressAsyncResultWait()

Result nsProgressAsyncResultWait ( NsProgressAsyncResult a,
u64  timeout 
)

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

Parameters
aNsProgressAsyncResult
[in]timeoutTimeout 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
pNsProgressMonitorForDeleteUserSaveDataAll

◆ nsProgressMonitorForDeleteUserSaveDataAllGetProgress()

Result nsProgressMonitorForDeleteUserSaveDataAllGetProgress ( NsProgressMonitorForDeleteUserSaveDataAll p,
NsProgressForDeleteUserSaveDataAll progress 
)

◆ nsProgressMonitorForDeleteUserSaveDataAllGetResult()

Result nsProgressMonitorForDeleteUserSaveDataAllGetResult ( NsProgressMonitorForDeleteUserSaveDataAll p)

◆ 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_eventOutput Event with autoclear=false.

◆ nsProgressMonitorForDeleteUserSaveDataAllIsFinished()

Result nsProgressMonitorForDeleteUserSaveDataAllIsFinished ( NsProgressMonitorForDeleteUserSaveDataAll p,
bool *  out 
)

IsFinished.

Parameters
pNsProgressMonitorForDeleteUserSaveDataAll
[out]outWhether 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]aAsyncValue. The data that can be read from this is u8 ApplicationUpdateInfo. qlaunch just checks whether this is 0.
application_idApplicationId.

◆ 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]aAsyncResult
[in]application_idApplicationId.

◆ 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]aAsyncResult
[in]application_idApplicationId.

◆ 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]aAsyncResult
[in]application_idApplicationId.

◆ 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]aAsyncValue

◆ 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]aAsyncResult

◆ 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]aAsyncValue. The data that can be read from this is 4-bytes.
[in]uidAccountUid
[in]application_idApplicationId.

◆ 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]aAsyncResult
[in]uidAccountUid

◆ 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]aAsyncValue. The data that can be read from this is u8 NoDownloadRightsErrorResolution.
application_idApplicationId.

◆ 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]aAsyncResult
[in]addrServer IPv4 address.
[in]portSocket port. qlaunch uses value 55556.
[in]application_idApplicationId
[in]metaInput array of NcmContentMetaKey. The NcmContentMetaType must match NcmContentMetaType_Patch.
[in]countSize of the meta array in entries.
[in]storage_idNcmStorageId. 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]aAsyncResult
[in]uidAccountUid
[in]application_idApplicationId.
[in]invalInput 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]aAsyncValue. The data that can be read from this is u8 NoDownloadRightsErrorResolution.
application_idApplicationId.

◆ 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]aAsyncResult
[in]addrClient IPv4 address.
[in]portSocket port. qlaunch uses value 55556.
[in]application_idApplicationId
[in]metaInput array of NcmContentMetaKey. The NcmContentMetaType must match NcmContentMetaType_Patch.
[in]countSize of the meta array in entries.

◆ nsRequestServerStopperClose()

void nsRequestServerStopperClose ( NsRequestServerStopper r)

◆ nsRequestSyncRights()

Result nsRequestSyncRights ( AsyncResult a)

RequestSyncRights.

Note
Only available on [6.0.0+].
Parameters
[out]aAsyncResult

◆ 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]aAsyncResult
[in]uidAccountUid

◆ 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]aAsyncResult
[in]application_idApplicationId.

◆ nsRequestVerifyAddOnContentsRights()

Result nsRequestVerifyAddOnContentsRights ( NsProgressAsyncResult a,
u64  application_id 
)

RequestVerifyAddOnContentsRights.

Note
Only available on [3.0.0-9.2.0].
Parameters
[out]aNsProgressAsyncResult
[in]application_idApplicationId.

◆ 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]aNsProgressAsyncResult. The data available with nsProgressAsyncResultGetProgress is basically the same as NsSystemUpdateProgress.
[in]application_idApplicationId.
[in]unkUnknown. A default value of 0x7 can be used (which is what qlaunch uses). Only used on [5.0.0+].
buffer0x1000-byte aligned buffer for TransferMemory. This buffer must not be accessed until the async operation finishes.
[in]size0x1000-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_idApplicationId.

◆ nsResumeApplicationDownload()

Result nsResumeApplicationDownload ( u64  application_id)

ResumeApplicationDownload.

Parameters
[in]application_idApplicationId.

◆ 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_listInput array of NsSystemDeliveryInfo.
[in]sys_countSize of the sys_list array in entries.
[in]base_infoNsSystemDeliveryInfo
[in]app_listInput array of NsApplicationDeliveryInfo. This can be NULL.
[in]app_countSize of the app_list array in entries. This can be 0.
[out]indexOutput index for the selected entry in sys_list, -1 if none found.

◆ nsSetApplicationTerminateResult()

Result nsSetApplicationTerminateResult ( u64  application_id,
Result  res 
)

SetApplicationTerminateResult.

Parameters
[in]application_idApplicationId.
[in]resResult.

◆ nssuControlApplyCardUpdate()

Result nssuControlApplyCardUpdate ( NsSystemUpdateControl c)

ApplyCardUpdate.

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

◆ nssuControlApplyDownloadedUpdate()

Result nssuControlApplyDownloadedUpdate ( NsSystemUpdateControl c)

ApplyDownloadedUpdate.

Parameters
cNsSystemUpdateControl

◆ nssuControlApplyReceivedUpdate()

Result nssuControlApplyReceivedUpdate ( NsSystemUpdateControl c)

ApplyReceivedUpdate.

Note
Only available on [4.0.0+].
Parameters
cNsSystemUpdateControl

◆ nssuControlClose()

void nssuControlClose ( NsSystemUpdateControl c)

◆ 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
cNsSystemUpdateControl
[in]pathEulaData path.
[out]bufferOutput buffer.
[in]sizeSize of the output buffer, must be at least the output size from nssuControlGetDownloadedEulaDataSize.
[out]filesizeOutput 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
cNsSystemUpdateControl
[in]pathEulaData path.
[out]filesizeOutput filesize.

◆ nssuControlGetDownloadProgress()

Result nssuControlGetDownloadProgress ( NsSystemUpdateControl c,
NsSystemUpdateProgress out 
)

GetDownloadProgress.

Parameters
cNsSystemUpdateControl
[out]outNsSystemUpdateProgress

◆ nssuControlGetPrepareCardUpdateProgress()

Result nssuControlGetPrepareCardUpdateProgress ( NsSystemUpdateControl c,
NsSystemUpdateProgress out 
)

GetPrepareCardUpdateProgress.

Note
nssuControlSetupCardUpdate / nssuControlSetupCardUpdateViaSystemUpdater must have been used at some point prior to using this.
Parameters
cNsSystemUpdateControl
[out]outNsSystemUpdateProgress

◆ 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
cNsSystemUpdateControl
[in]pathEulaData path.
[out]bufferOutput buffer.
[in]sizeSize of the output buffer, must be at least the output size from nssuControlGetPreparedCardUpdateEulaDataSize.
[out]filesizeOutput 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
cNsSystemUpdateControl
[in]pathEulaData path.
[out]filesizeOutput 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
cNsSystemUpdateControl
[in]pathEulaData path.
[out]bufferOutput buffer.
[in]sizeSize of the output buffer, must be at least the output size from nssuControlGetReceivedEulaDataSize.
[out]filesizeOutput 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
cNsSystemUpdateControl
[in]pathEulaData path.
[out]filesizeOutput filesize.

◆ nssuControlGetReceiveProgress()

Result nssuControlGetReceiveProgress ( NsSystemUpdateControl c,
NsSystemUpdateProgress out 
)

GetReceiveProgress.

Note
Only available on [4.0.0+].
Parameters
cNsSystemUpdateControl
[out]outNsSystemUpdateProgress

◆ nssuControlHasDownloaded()

Result nssuControlHasDownloaded ( NsSystemUpdateControl c,
bool *  out 
)

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

Parameters
cNsSystemUpdateControl
[out]outOutput flag.

◆ nssuControlHasPreparedCardUpdate()

Result nssuControlHasPreparedCardUpdate ( NsSystemUpdateControl c,
bool *  out 
)

HasPreparedCardUpdate.

Note
nssuControlSetupCardUpdate / nssuControlSetupCardUpdateViaSystemUpdater must have been used at some point prior to using this.
Parameters
cNsSystemUpdateControl
[out]outOutput flag.

◆ nssuControlHasReceived()

Result nssuControlHasReceived ( NsSystemUpdateControl c,
bool *  out 
)

HasReceived.

Note
Only available on [4.0.0+].
Parameters
cNsSystemUpdateControl
[out]outOutput flag.

◆ nssuControlRequestCheckLatestUpdate()

Result nssuControlRequestCheckLatestUpdate ( NsSystemUpdateControl c,
AsyncValue a 
)

RequestCheckLatestUpdate.

Parameters
cNsSystemUpdateControl
[out]aAsyncValue. 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
cNsSystemUpdateControl
[out]aAsyncValue

◆ nssuControlRequestDownloadLatestUpdate()

Result nssuControlRequestDownloadLatestUpdate ( NsSystemUpdateControl c,
AsyncResult a 
)

RequestDownloadLatestUpdate.

Parameters
cNsSystemUpdateControl
[out]aAsyncResult

◆ nssuControlRequestPrepareCardUpdate()

Result nssuControlRequestPrepareCardUpdate ( NsSystemUpdateControl c,
AsyncResult a 
)

RequestPrepareCardUpdate.

Parameters
cNsSystemUpdateControl
[out]aAsyncResult

◆ 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
cNsSystemUpdateControl
[out]aAsyncResult
[in]addrServer IPv4 address. qlaunch uses a local-WLAN addr, however this can be any addr.
[in]portSocket port. qlaunch uses value 55556.
[in]infoNsSystemDeliveryInfo

◆ nssuControlSetupCardUpdate()

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

SetupCardUpdate.

Parameters
cNsSystemUpdateControl
[in]bufferTransferMemory buffer, when NULL this is automatically allocated.
[in]sizeTransferMemory 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
cNsSystemUpdateControl
[in]bufferTransferMemory buffer, when NULL this is automatically allocated.
[in]sizeTransferMemory 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
cNsSystemUpdateControl

◆ 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]outNsBackgroundNetworkUpdateState

◆ nssuGetSendSystemUpdateProgress()

Result nssuGetSendSystemUpdateProgress ( NsSystemUpdateProgress out)

GetSendSystemUpdateProgress.

Note
Only available on [4.0.0+].
Parameters
[out]outNsSystemUpdateProgress

◆ 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_eventOutput 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]keyNcmContentMetaKey

◆ 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]cNsSystemUpdateControl

◆ 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]aAsyncResult
[in]addrClient IPv4 address. qlaunch uses a local-WLAN addr.
[in]portSocket port. qlaunch uses value 55556.
[in]infoNsSystemDeliveryInfo

◆ nsTouchApplication()

Result nsTouchApplication ( u64  application_id)

TouchApplication.

Note
Only available on [2.0.0+].
Parameters
[in]application_idApplicationId.

◆ 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]uidAccountUid

◆ nsUnregisterNetworkServiceAccountWithUserSaveDataDeletion()

Result nsUnregisterNetworkServiceAccountWithUserSaveDataDeletion ( AccountUid  uid)

UnregisterNetworkServiceAccountWithUserSaveDataDeletion.

Note
Only available on [6.0.0+].
Parameters
[in]uidAccountUid

◆ nsVerifyDeliveryProtocolVersion()

Result nsVerifyDeliveryProtocolVersion ( const NsSystemDeliveryInfo info)

VerifyDeliveryProtocolVersion.

Note
Only available on [4.0.0+].
Parameters
[in]infoNsSystemDeliveryInfo

◆ nsWithdrawApplicationUpdateRequest()

Result nsWithdrawApplicationUpdateRequest ( u64  application_id)

WithdrawApplicationUpdateRequest.

Note
Only available on [2.0.0+].
Parameters
[in]application_idApplicationId.