Difference between revisions of "FRDU:GetFriendComment"

From 3dbrew
Jump to navigation Jump to search
(Created page with "=Request= {{IPC/Request}} {{IPC/RequestHeader|0x0031|2|2}} {{IPC/RequestEntry|Total amount of UTF-16 characters the output buffer can hold (max. 0x400) (Count * 0x11)}} {{IPC/...")
 
 
(2 intermediate revisions by the same user not shown)
Line 2: Line 2:
 
{{IPC/Request}}
 
{{IPC/Request}}
 
{{IPC/RequestHeader|0x0031|2|2}}
 
{{IPC/RequestHeader|0x0031|2|2}}
{{IPC/RequestEntry|Total amount of UTF-16 characters the output buffer can hold (max. 0x400) (Count * 0x11)}}
+
{{IPC/RequestEntry|<b>Number of UTF-16 characters</b> the output friend comment buffer can fit (maximum 0xC00, corresponding to a total max buffer size of 0x1800) (Count * 17)}}
 
{{IPC/RequestEntry|Count}}
 
{{IPC/RequestEntry|Count}}
 
{{IPC/TranslateStaticBuffer|Input [[Friend_Services#FriendKey|FriendKey]] buffer|0}}
 
{{IPC/TranslateStaticBuffer|Input [[Friend_Services#FriendKey|FriendKey]] buffer|0}}
Line 10: Line 10:
 
{{IPC/RequestStaticBuffers}}
 
{{IPC/RequestStaticBuffers}}
 
{{#vardefine:ipc_offset|0}}
 
{{#vardefine:ipc_offset|0}}
{{IPC/TranslateStaticBuffer|Output friend comment buffer (Count * 0x11) (16 characters + null termination each)|0}}
+
{{IPC/TranslateStaticBuffer|Pointer to output UTF-16 friend comments (16 characters + null termination <b>each</b>)|0}}
 
{{IPC/RequestEnd}}
 
{{IPC/RequestEnd}}
  
Line 18: Line 18:
 
{{IPC/RequestHeader|0x0031|1|2}}
 
{{IPC/RequestHeader|0x0031|1|2}}
 
{{IPC/RequestEntry|Result code}}
 
{{IPC/RequestEntry|Result code}}
{{IPC/TranslateStaticBuffer|Output friend comment buffer|0}}
+
{{IPC/TranslateStaticBuffer|Pointer to output UTF-16 friend comments|0}}
 
{{IPC/RequestEnd}}
 
{{IPC/RequestEnd}}
  
 
=Description=
 
=Description=
Returns the friend comment (personal message) set in the friends list for the specified friend keys. If an input friend key was not found in the friends list, t
+
Returns the friend comment (personal message) set in the friends list for the specified friend keys. If an input friend key was not found in the friends list, an internal default placeholder friend entry will be used to populate the data.

Latest revision as of 21:31, 15 December 2024

Request[edit]

Index Word Description
0
Header 0x00310082 Cmd 0x0031 Param 2 Xlat 2
1 Number of UTF-16 characters the output friend comment buffer can fit (maximum 0xC00, corresponding to a total max buffer size of 0x1800) (Count * 17)
2 Count
3 Descriptor for static buffer (id 0)
4 Input FriendKey buffer

Request Static Buffers[edit]

The handler for this IPC command expects the following 0x100-bytes after the beginning of the above command buffer:

Index Word Description


0 Descriptor for static buffer (id 0)
1 Pointer to output UTF-16 friend comments (16 characters + null termination each)

Response[edit]

Index Word Description
0
Header 0x00310042 Cmd 0x0031 Param 1 Xlat 2
1 Result code
2 Descriptor for static buffer (id 0)
3 Pointer to output UTF-16 friend comments

Description[edit]

Returns the friend comment (personal message) set in the friends list for the specified friend keys. If an input friend key was not found in the friends list, an internal default placeholder friend entry will be used to populate the data.