BOSSU:GetNsDataIdList - Revision history

DaniElectra: /* Internals */ Add more info about first type parameter

2025-08-30T16:16:47Z

Internals: Add more info about first type parameter

← Older revision		Revision as of 20:16, 30 August 2025
Line 30:		Line 30:
	! Value !! Description		! Value !! Description
	\|-		\|-
	\| 0 \|\| Allow everything		\| 0 \|\| Allow everything. This will also unset the [[BOSS_Savegame#BOSS_A_TitleInfo\|arrival flag]]
	\|-		\|-
	\| 1 \|\| Only allow entries which don't have the new flag set		\| 1 \|\| Only allow entries which don't have the new flag set. This will also set the [[BOSS_Savegame#BOSS_A_TitleInfo\|arrival flag]]
	\|-		\|-
	\| 2 \|\| Only allow entries which have the new flag set		\| 2 \|\| Only allow entries which have the new flag set. This will also set the [[BOSS_Savegame#BOSS_A_TitleInfo\|arrival flag]]
	\|}		\|}

DaniElectra: /* Description */ Explain type parameters

2025-08-21T13:57:41Z

Description: Explain type parameters

@@ Line 22: / Line 22: @@
 Writes an array of NS Data ID entries (u32) for the program ID of the current session to the output buffer using the provided filters.
 This eventually calls a function with the following type parameters: 0, 1, 1. This function doesn't use the second type parameter. Afterwards another function is called using the program ID.
 =Filter=

DaniElectra: Use IPC template header

2025-02-01T16:34:55Z

Use IPC template header

← Older revision		Revision as of 19:34, 1 February 2025
Line 1:		Line 1:
	=Request=		=Request=
	{{IPC/Request}}		{{IPC/Request}}
	~~{{#vardefine:ipc_offset\|0}}~~		{{IPC/RequestHeader\|0x0010\|4\|2}}
	{{IPC/~~RequestEntry~~\|~~Header code [0x00100102]~~}}		{{IPC/RequestEntry\|u32, Filter}}
	{{IPC/RequestEntry\|u32 ~~filter~~}}		{{IPC/RequestEntry\|u32, Number of entries that the list can hold (max entries)}}
	{{IPC/RequestEntry\|~~Buffer size in words~~(max entries).}}		{{IPC/RequestEntry\|u16, Starting index in the internal NS Data ID list}}
	{{IPC/RequestEntry\|u16, ~~starting word-~~index in the internal ~~NsDataId~~ list.}}		{{IPC/RequestEntry\|u32, Starting NS Data ID}}
	{{IPC/RequestEntry\|u32, ~~start_NsDataId.~~}}		{{IPC/MapPointerW\|Output NS Data ID list}}
	{{IPC/MapPointerW\|~~Destination pointer~~}}
	{{IPC/RequestEnd}}		{{IPC/RequestEnd}}

Line 13:		Line 12:
	{{IPC/Request}}		{{IPC/Request}}
	{{#vardefine:ipc_offset\|0}}		{{#vardefine:ipc_offset\|0}}
	{{IPC/~~RequestEntry~~\|~~Header code~~}}		{{IPC/RequestHeader\|0x0010\|3\|2}}
	{{IPC/RequestEntry\|Result code}}		{{IPC/RequestEntry\|Result code}}
	{{IPC/RequestEntry\|u16 Actual number of output entries.}}		{{IPC/RequestEntry\|u16, Actual number of output entries}}
	{{IPC/RequestEntry\|u16 Last ~~word-~~index copied to output in the internal ~~NsDataId~~ list.}}		{{IPC/RequestEntry\|u16, Last index copied to output in the internal NS Data ID list}}
			{{IPC/MapPointerW\|Output NS Data ID list}}
	{{IPC/RequestEnd}}		{{IPC/RequestEnd}}

			=Description=
			Writes an array of NS Data ID entries (u32) for the program ID of the current session to the output buffer using the provided filters.

			This eventually calls a function with the following type parameters: 0, 1, 1. This function doesn't use the second type parameter. Afterwards another function is called using the program ID.

	=Filter=		=Filter=
	Content filtering is enabled when this word isn't ~~0xffffffff~~. This is only used for the following: <code>if(filterword_u16high!=contentdatatype_u16high \|\| (filterword_u16low & contentdatatype_u16low) == 0)continue;</code> Hence, filterword_u16high must match contentdatatype_u16high, and the bitmask specified by filterword_u16low must be non-zero in contentdatatype_u16low. The contentdatatype is extracted from the extdata filename, which originates from the [[SpotPass\|BOSS-container]]. The ~~NsDataId~~ for the content entry is only written to the output when processing isn't skipped due to filtering.		Content filtering is enabled when this word isn't 0xFFFFFFFF. This is only used for the following: <code>if (filterword_u16high != contentdatatype_u16high \|\| (filterword_u16low & contentdatatype_u16low) == 0) continue;</code> Hence, filterword_u16high must match contentdatatype_u16high, and the bitmask specified by filterword_u16low must be non-zero in contentdatatype_u16low. The contentdatatype is extracted from the extdata filename, which originates from the [[SpotPass\|BOSS-container]]. The NS Data ID for the content entry is only written to the output when processing isn't skipped due to filtering.

	=Start NsDataId=		=Start NsDataId=
	This field is only used when ~~starting_wordindex~~ is non-zero or when this field is non-zero.		This field is only used when the starting index is non-zero or when this field is non-zero.

	The NsDataId at the specified start-wordindex must match this field, otherwise error 0xD840F846 is returned. It will then skip normal content entry processing for this matching entry(cur_wordindex is field is increased by 0x1 before starting the content entry processing loop).

	~~=Description=~~
	~~This writes an array of u32 entries(NsDataId) to the output buffer, for the current programID~~.

	~~This eventually calls a function with~~ the ~~following type parameters: 0~~, ~~1, 1~~. ~~This function doesn't use the second type parameter. Afterwards another function~~ is ~~called using~~ the ~~programID~~.		The NS Data ID at the specified starting index must match this field, otherwise error 0xD840F846 is returned. It will then skip normal content entry processing for this matching entry (cur_wordindex is field is increased by 0x1 before starting the content entry processing loop).

Yellows8: /* Filter */

2016-12-28T19:33:28Z

Filter

← Older revision		Revision as of 22:33, 28 December 2016
Line 20:		Line 20:

	=Filter=		=Filter=
	Content filtering is enabled when this word isn't 0xffffffff. This is only used for the following: <code>if(filterword_u16high!=~~contententryword_u16high~~ \|\| (filterword_u16low & ~~contententryword_u16low~~) == 0)continue;</code> The ~~contententryword~~ is ~~separate~~ from ~~NsDataId~~. The NsDataId for the content entry is only written to the output when ~~these checks pass~~.		Content filtering is enabled when this word isn't 0xffffffff. This is only used for the following: <code>if(filterword_u16high!=contentdatatype_u16high \|\| (filterword_u16low & contentdatatype_u16low) == 0)continue;</code> Hence, filterword_u16high must match contentdatatype_u16high, and the bitmask specified by filterword_u16low must be non-zero in contentdatatype_u16low. The contentdatatype is extracted from the extdata filename, which originates from the [[SpotPass\|BOSS-container]]. The NsDataId for the content entry is only written to the output when processing isn't skipped due to filtering.

	=Start NsDataId=		=Start NsDataId=

Yellows8 at 07:59, 28 December 2016

2016-12-28T06:59:21Z

← Older revision		Revision as of 09:59, 28 December 2016
Line 5:		Line 5:
	{{IPC/RequestEntry\|u32 filter}}		{{IPC/RequestEntry\|u32 filter}}
	{{IPC/RequestEntry\|Buffer size in words(max entries).}}		{{IPC/RequestEntry\|Buffer size in words(max entries).}}
	{{IPC/RequestEntry\|u16, starting word-index in the internal NsDataId list~~. Added with 0x1 to determine the actual word-index. 0xFFFF is for using actual-word-index 0~~.}}		{{IPC/RequestEntry\|u16, starting word-index in the internal NsDataId list.}}
	{{IPC/RequestEntry\|u32, ~~target NsDataId~~.}}		{{IPC/RequestEntry\|u32, start_NsDataId.}}
	{{IPC/MapPointerW\|Destination pointer}}		{{IPC/MapPointerW\|Destination pointer}}
	{{IPC/RequestEnd}}		{{IPC/RequestEnd}}
Line 22:		Line 22:
	Content filtering is enabled when this word isn't 0xffffffff. This is only used for the following: <code>if(filterword_u16high!=contententryword_u16high \|\| (filterword_u16low & contententryword_u16low) == 0)continue;</code> The contententryword is separate from NsDataId. The NsDataId for the content entry is only written to the output when these checks pass.		Content filtering is enabled when this word isn't 0xffffffff. This is only used for the following: <code>if(filterword_u16high!=contententryword_u16high \|\| (filterword_u16low & contententryword_u16low) == 0)continue;</code> The contententryword is separate from NsDataId. The NsDataId for the content entry is only written to the output when these checks pass.

	=~~Target~~ NsDataId=		=Start NsDataId=
	This field is only used when starting_wordindex is non-zero or when this field is non-zero.		This field is only used when starting_wordindex is non-zero or when this field is non-zero.

	The NsDataId at the specified start-wordindex must match this field, otherwise error 0xD840F846 is returned.		The NsDataId at the specified start-wordindex must match this field, otherwise error 0xD840F846 is returned. It will then skip normal content entry processing for this matching entry(cur_wordindex is field is increased by 0x1 before starting the content entry processing loop).

	=Description=		=Description=

Yellows8 at 07:27, 28 December 2016

2016-12-28T06:27:25Z

← Older revision		Revision as of 09:27, 28 December 2016
Line 6:		Line 6:
	{{IPC/RequestEntry\|Buffer size in words(max entries).}}		{{IPC/RequestEntry\|Buffer size in words(max entries).}}
	{{IPC/RequestEntry\|u16, starting word-index in the internal NsDataId list. Added with 0x1 to determine the actual word-index. 0xFFFF is for using actual-word-index 0.}}		{{IPC/RequestEntry\|u16, starting word-index in the internal NsDataId list. Added with 0x1 to determine the actual word-index. 0xFFFF is for using actual-word-index 0.}}
	{{IPC/RequestEntry\|u32, ~~unknown~~.}}		{{IPC/RequestEntry\|u32, target NsDataId.}}
	{{IPC/MapPointerW\|Destination pointer}}		{{IPC/MapPointerW\|Destination pointer}}
	{{IPC/RequestEnd}}		{{IPC/RequestEnd}}
Line 21:		Line 21:
	=Filter=		=Filter=
	Content filtering is enabled when this word isn't 0xffffffff. This is only used for the following: <code>if(filterword_u16high!=contententryword_u16high \|\| (filterword_u16low & contententryword_u16low) == 0)continue;</code> The contententryword is separate from NsDataId. The NsDataId for the content entry is only written to the output when these checks pass.		Content filtering is enabled when this word isn't 0xffffffff. This is only used for the following: <code>if(filterword_u16high!=contententryword_u16high \|\| (filterword_u16low & contententryword_u16low) == 0)continue;</code> The contententryword is separate from NsDataId. The NsDataId for the content entry is only written to the output when these checks pass.

			=Target NsDataId=
			This field is only used when starting_wordindex is non-zero or when this field is non-zero.

			The NsDataId at the specified start-wordindex must match this field, otherwise error 0xD840F846 is returned.

	=Description=		=Description=

Yellows8: /* Request */

2016-12-28T06:13:23Z

Request

← Older revision		Revision as of 09:13, 28 December 2016
Line 5:		Line 5:
	{{IPC/RequestEntry\|u32 filter}}		{{IPC/RequestEntry\|u32 filter}}
	{{IPC/RequestEntry\|Buffer size in words(max entries).}}		{{IPC/RequestEntry\|Buffer size in words(max entries).}}
	{{IPC/RequestEntry\|u16, ~~unknown~~.}}		{{IPC/RequestEntry\|u16, starting word-index in the internal NsDataId list. Added with 0x1 to determine the actual word-index. 0xFFFF is for using actual-word-index 0.}}
	{{IPC/RequestEntry\|u32, unknown.}}		{{IPC/RequestEntry\|u32, unknown.}}
	{{IPC/MapPointerW\|Destination pointer}}		{{IPC/MapPointerW\|Destination pointer}}

Yellows8: /* Response */

2016-12-28T06:06:03Z

Response

← Older revision		Revision as of 09:06, 28 December 2016
Line 16:		Line 16:
	{{IPC/RequestEntry\|Result code}}		{{IPC/RequestEntry\|Result code}}
	{{IPC/RequestEntry\|u16 Actual number of output entries.}}		{{IPC/RequestEntry\|u16 Actual number of output entries.}}
	{{IPC/RequestEntry\|u16 ~~Unknown~~}}		{{IPC/RequestEntry\|u16 Last word-index copied to output in the internal NsDataId list.}}
	{{IPC/RequestEnd}}		{{IPC/RequestEnd}}

Yellows8 at 06:56, 28 December 2016

2016-12-28T05:56:50Z

← Older revision		Revision as of 08:56, 28 December 2016
Line 3:		Line 3:
	{{#vardefine:ipc_offset\|0}}		{{#vardefine:ipc_offset\|0}}
	{{IPC/RequestEntry\|Header code [0x00100102]}}		{{IPC/RequestEntry\|Header code [0x00100102]}}
	{{IPC/RequestEntry\|~~Unknown, usually 0xffffffff.~~}}		{{IPC/RequestEntry\|u32 filter}}
	{{IPC/RequestEntry\|Buffer size in words(max entries).}}		{{IPC/RequestEntry\|Buffer size in words(max entries).}}
	{{IPC/RequestEntry\|u16, unknown.}}		{{IPC/RequestEntry\|u16, unknown.}}
Line 18:		Line 18:
	{{IPC/RequestEntry\|u16 Unknown}}		{{IPC/RequestEntry\|u16 Unknown}}
	{{IPC/RequestEnd}}		{{IPC/RequestEnd}}

			=Filter=
			Content filtering is enabled when this word isn't 0xffffffff. This is only used for the following: <code>if(filterword_u16high!=contententryword_u16high \|\| (filterword_u16low & contententryword_u16low) == 0)continue;</code> The contententryword is separate from NsDataId. The NsDataId for the content entry is only written to the output when these checks pass.

	=Description=		=Description=

Yellows8: /* Description */

2016-12-27T23:42:40Z

Description

← Older revision		Revision as of 02:42, 28 December 2016
Line 22:		Line 22:
	This writes an array of u32 entries(NsDataId) to the output buffer, for the current programID.		This writes an array of u32 entries(NsDataId) to the output buffer, for the current programID.

	This eventually calls a function with the following type parameters: 0, 1, 1. Afterwards another function is called using the programID.		This eventually calls a function with the following type parameters: 0, 1, 1. This function doesn't use the second type parameter. Afterwards another function is called using the programID.

← Older revision		Revision as of 09:13, 28 December 2016
Line 5:		Line 5:
	{{IPC/RequestEntry\|u32 filter}}		{{IPC/RequestEntry\|u32 filter}}
	{{IPC/RequestEntry\|Buffer size in words(max entries).}}		{{IPC/RequestEntry\|Buffer size in words(max entries).}}
	{{IPC/RequestEntry\|u16, ~~unknown~~.}}		{{IPC/RequestEntry\|u16, starting word-index in the internal NsDataId list. Added with 0x1 to determine the actual word-index. 0xFFFF is for using actual-word-index 0.}}
	{{IPC/RequestEntry\|u32, unknown.}}		{{IPC/RequestEntry\|u32, unknown.}}
	{{IPC/MapPointerW\|Destination pointer}}		{{IPC/MapPointerW\|Destination pointer}}

← Older revision		Revision as of 08:56, 28 December 2016
Line 3:		Line 3:
	{{#vardefine:ipc_offset\|0}}		{{#vardefine:ipc_offset\|0}}
	{{IPC/RequestEntry\|Header code [0x00100102]}}		{{IPC/RequestEntry\|Header code [0x00100102]}}
	{{IPC/RequestEntry\|~~Unknown, usually 0xffffffff.~~}}		{{IPC/RequestEntry\|u32 filter}}
	{{IPC/RequestEntry\|Buffer size in words(max entries).}}		{{IPC/RequestEntry\|Buffer size in words(max entries).}}
	{{IPC/RequestEntry\|u16, unknown.}}		{{IPC/RequestEntry\|u16, unknown.}}
Line 18:		Line 18:
	{{IPC/RequestEntry\|u16 Unknown}}		{{IPC/RequestEntry\|u16 Unknown}}
	{{IPC/RequestEnd}}		{{IPC/RequestEnd}}

			=Filter=
			Content filtering is enabled when this word isn't 0xffffffff. This is only used for the following: <code>if(filterword_u16high!=contententryword_u16high \|\| (filterword_u16low & contententryword_u16low) == 0)continue;</code> The contententryword is separate from NsDataId. The NsDataId for the content entry is only written to the output when these checks pass.

	=Description=		=Description=