Difference between revisions of "GetFKeyPtr"

From WikiPrizm
Jump to navigationJump to search
(Created page with "{{syscall | name = GetFKeyPtr | index = 0x12F3 | signature = void GetFKeyPtr( int, void* ) | header = display_syscalls.h | comments = }}")
 
 
(4 intermediate revisions by 2 users not shown)
Line 2: Line 2:
 
| name = GetFKeyPtr
 
| name = GetFKeyPtr
 
| index = 0x12F3
 
| index = 0x12F3
| signature = void GetFKeyPtr( int, void* )
+
| signature = ''void'' '''GetFKeyPtr'''(''int'' '''id''', ''void*'' '''result''')
| header = display_syscalls.h
+
| header = fxcg/display.h
| comments =  
+
| parameters =
 +
* ''int'' '''id''' - The ID (between 0 and 0x04E0) of the FKey bitmap stored in the memory. Use Insight's ''FKey icons'' option, or the [[TestMode]], to find the ID for an Fkey icon.
 +
* ''void*'' '''result''' - Pointer to an integer variable which can be used with [[FKey_Display]].
 +
| returns = The function sets the given variable as a pointer to the start of the requested bitmap.
 +
| synopsis = This function tells you the position of a requested [[FKey bitmap|FKey icon]] in the currently selected [[Locale|language for function key labels]].
 +
| example =
 +
This code displays "TEST" above F1 button:
 +
<pre>
 +
int iresult;
 +
GetFKeyPtr(0x0003, &iresult);
 +
FKey_Display(0, iresult);
 +
</pre>
 
}}
 
}}
 +
[[Category:Syscalls:Locale]]

Latest revision as of 18:53, 15 November 2014


Synopsis

Header: fxcg/display.h
Syscall index: 0x12F3
Function signature: void GetFKeyPtr(int id, void* result)

This function tells you the position of a requested FKey icon in the currently selected language for function key labels.

Parameters

  • int id - The ID (between 0 and 0x04E0) of the FKey bitmap stored in the memory. Use Insight's FKey icons option, or the TestMode, to find the ID for an Fkey icon.
  • void* result - Pointer to an integer variable which can be used with FKey_Display.

Returns

The function sets the given variable as a pointer to the start of the requested bitmap.

Example

This code displays "TEST" above F1 button:

int iresult;
GetFKeyPtr(0x0003, &iresult);
FKey_Display(0, iresult);