libnx  v4.2.0
Data Structures | Enumerations | Functions
nfp_la.h File Reference

Wrapper for using the cabinet (amiibo) LibraryApplet. More...

#include "../types.h"
#include "../services/nfc.h"

Go to the source code of this file.

Data Structures

struct  NfpLaAmiiboSettingsStartParam
 AmiiboSettingsStartParam. More...
 
struct  NfpLaStartParamForAmiiboSettings
 StartParamForAmiiboSettings. More...
 
struct  NfpLaReturnValueForAmiiboSettings
 ReturnValueForAmiiboSettings. More...
 

Enumerations

enum  NfpLaStartParamTypeForAmiiboSettings {
  NfpLaStartParamTypeForAmiiboSettings_NicknameAndOwnerSettings = 0,
  NfpLaStartParamTypeForAmiiboSettings_GameDataEraser = 1,
  NfpLaStartParamTypeForAmiiboSettings_Restorer = 2,
  NfpLaStartParamTypeForAmiiboSettings_Formatter = 3
}
 Values for NfpLaStartParamForAmiiboSettings::type. More...
 

Functions

Result nfpLaStartNicknameAndOwnerSettings (const NfpLaAmiiboSettingsStartParam *in_param, const NfpTagInfo *in_tag_info, const NfpRegisterInfo *in_reg_info, NfpTagInfo *out_tag_info, NfcDeviceHandle *handle, bool *reg_info_flag, NfpRegisterInfo *out_reg_info)
 Launches the applet for NicknameAndOwnerSettings. More...
 
Result nfpLaStartGameDataEraser (const NfpLaAmiiboSettingsStartParam *in_param, const NfpTagInfo *in_tag_info, NfpTagInfo *out_tag_info, NfcDeviceHandle *handle)
 Launches the applet for GameDataEraser. More...
 
Result nfpLaStartRestorer (const NfpLaAmiiboSettingsStartParam *in_param, const NfpTagInfo *in_tag_info, NfpTagInfo *out_tag_info, NfcDeviceHandle *handle)
 Launches the applet for Restorer. More...
 
Result nfpLaStartFormatter (const NfpLaAmiiboSettingsStartParam *in_param, NfpTagInfo *out_tag_info, NfcDeviceHandle *handle)
 Launches the applet for Formatter. More...
 

Detailed Description

Wrapper for using the cabinet (amiibo) LibraryApplet.

Author
yellows8

Enumeration Type Documentation

◆ NfpLaStartParamTypeForAmiiboSettings

Values for NfpLaStartParamForAmiiboSettings::type.

Enumerator
NfpLaStartParamTypeForAmiiboSettings_NicknameAndOwnerSettings 

NicknameAndOwnerSettings.

NfpLaStartParamTypeForAmiiboSettings_GameDataEraser 

GameDataEraser.

NfpLaStartParamTypeForAmiiboSettings_Restorer 

Restorer.

NfpLaStartParamTypeForAmiiboSettings_Formatter 

Formatter.

Function Documentation

◆ nfpLaStartFormatter()

Result nfpLaStartFormatter ( const NfpLaAmiiboSettingsStartParam in_param,
NfpTagInfo out_tag_info,
NfcDeviceHandle handle 
)

Launches the applet for Formatter.

Parameters
[in]in_paramNfpLaAmiiboSettingsStartParam
[out]out_tag_infoNfpTagInfo
[out]handleNfcDeviceHandle

◆ nfpLaStartGameDataEraser()

Result nfpLaStartGameDataEraser ( const NfpLaAmiiboSettingsStartParam in_param,
const NfpTagInfo in_tag_info,
NfpTagInfo out_tag_info,
NfcDeviceHandle handle 
)

Launches the applet for GameDataEraser.

Note
Official sw does not expose functionality for using input/output NfpTagInfo at the same time.
Parameters
[in]in_paramNfpLaAmiiboSettingsStartParam
[in]in_tag_infoNfpTagInfo. Optional, can be NULL. If specified, this must match the scanned amiibo.
[out]out_tag_infoNfpTagInfo. Optional, can be NULL.
[out]handleNfcDeviceHandle

◆ nfpLaStartNicknameAndOwnerSettings()

Result nfpLaStartNicknameAndOwnerSettings ( const NfpLaAmiiboSettingsStartParam in_param,
const NfpTagInfo in_tag_info,
const NfpRegisterInfo in_reg_info,
NfpTagInfo out_tag_info,
NfcDeviceHandle handle,
bool *  reg_info_flag,
NfpRegisterInfo out_reg_info 
)

Launches the applet for NicknameAndOwnerSettings.

Note
Official sw does not expose functionality for using input/output NfpTagInfo at the same time.
Parameters
[in]in_paramNfpLaAmiiboSettingsStartParam
[in]in_tag_infoNfpTagInfo. Optional, can be NULL. If specified, this must match the scanned amiibo.
[in]in_reg_infoNfpRegisterInfo. Optional, can be NULL. If specified, this sets the NfpRegisterInfo which will be used for writing, with an option for the user to change it.
[out]out_tag_infoNfpTagInfo. Optional, can be NULL.
[out]handleNfcDeviceHandle
[out]reg_info_flagFlag indicating whether the data for out_reg_info is set. Optional, can be NULL.
[out]out_reg_infoNfpRegisterInfo, see reg_info_flag. Optional, can be NULL.

◆ nfpLaStartRestorer()

Result nfpLaStartRestorer ( const NfpLaAmiiboSettingsStartParam in_param,
const NfpTagInfo in_tag_info,
NfpTagInfo out_tag_info,
NfcDeviceHandle handle 
)

Launches the applet for Restorer.

Note
Official sw does not expose functionality for using input/output NfpTagInfo at the same time.
Parameters
[in]in_paramNfpLaAmiiboSettingsStartParam
[in]in_tag_infoNfpTagInfo. Optional, can be NULL. If specified, this must match the scanned amiibo.
[out]out_tag_infoNfpTagInfo. Optional, can be NULL.
[out]handleNfcDeviceHandle