Differences

This shows you the differences between two versions of the page.

--- macros:function:handles.createhandlereference [2018/08/24 13:59] – created icke_siegen
+++ macros:function:handles.createhandlereference [2021/06/10 18:06] (current) – external edit 127.0.0.1
@@ Line 1: / Line 1: @@
 Function
-====== CreateHandleReference ======
+====== Handles.CreateHandleReference ======
   HandleReference Handles.CreateHandleReference(String group, Int32 page, Int32 index)
@@ Line 12: / Line 12: @@
 ^ ::: | index ( [[macros:type:int32]] ) : Index of the handle within this page. |
 ^ return value | [[macros:identifier:handle]] |
+Used to pass a handle reference when creating a new one, when the handle does not yet exist.
+Page and index are 0-based, e.g. ("Groups", 0, 0) is the first button on page 1 in the groups window.
+Gregory Haynes gives a good explanation for its use when a function requires a handle which is yet to be created (here: [[:macros:function:Group.QuickCreateGroup]]):
+> The handle search converter which is used to interpret the "Location=Groups,1,10" is designed to find a handle based on the description. If there is no matching handle i.e. a recorded group then it will return null (nothing) and therefore it cannot be used to specify a location where nothing exists. What you need instead is a handle reference so you could do something like the following:
+>
+> ''Group.QuickCreateGroup(Handles.CreateHandleReference("Groups", 1, 10), userNumber:10, "Group 10", 0)''
 == Example in ==