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

Wrapper for using the Parental Controls authentication LibraryApplet. This applet is used by qlaunch. More...

#include "../types.h"

Go to the source code of this file.

Data Structures

struct  PctlAuthArg
 Input arg storage for the applet. More...
 

Enumerations

enum  PctlAuthType {
  PctlAuthType_Show = 0,
  PctlAuthType_RegisterPasscode = 1,
  PctlAuthType_ChangePasscode = 2
}
 Type values for PctlAuthArg::type. More...
 

Functions

Result pctlauthShow (bool flag)
 Launches the applet. More...
 
Result pctlauthShowEx (u8 arg0, u8 arg1, u8 arg2)
 Launches the applet. More...
 
Result pctlauthShowForConfiguration (void)
 Just calls: pctlauthShowEx(1, 0, 1). More...
 
Result pctlauthRegisterPasscode (void)
 Launches the applet for registering the Parental Controls PIN.
 
Result pctlauthChangePasscode (void)
 Launches the applet for changing the Parental Controls PIN. More...
 

Detailed Description

Wrapper for using the Parental Controls authentication LibraryApplet. This applet is used by qlaunch.

Author
yellows8

Enumeration Type Documentation

◆ PctlAuthType

Type values for PctlAuthArg::type.

Enumerator
PctlAuthType_Show 

ShowParentalAuthentication.

PctlAuthType_RegisterPasscode 

RegisterParentalPasscode.

PctlAuthType_ChangePasscode 

ChangeParentalPasscode.

Function Documentation

◆ pctlauthChangePasscode()

Result pctlauthChangePasscode ( void  )

Launches the applet for changing the Parental Controls PIN.

Note
Should not be used if a PIN is not already registered. See pctlIsRestrictionEnabled.

◆ pctlauthShow()

Result pctlauthShow ( bool  flag)

Launches the applet.

Note
Should not be used if a PIN is not already registered. See pctlIsRestrictionEnabled.
Parameters
flagInput flag. false = temporarily disable Parental Controls. true = validate the input PIN.

◆ pctlauthShowEx()

Result pctlauthShowEx ( u8  arg0,
u8  arg1,
u8  arg2 
)

Launches the applet.

Only available with [4.0.0+].

Parameters
arg0Value for PctlAuthArg.arg0.
arg1Value for PctlAuthArg.arg1.
arg2Value for PctlAuthArg.arg2.

◆ pctlauthShowForConfiguration()

Result pctlauthShowForConfiguration ( void  )

Just calls: pctlauthShowEx(1, 0, 1).

Launches the applet for checking the PIN, used when changing system-settings.

Note
Should not be used if a PIN is not already registered. See pctlIsRestrictionEnabled.