ahkExecuteLine

Exported function that executes script from given line pointer.


OutputVar := ahkExecuteLine(LinePointer, Mode, Wait)
Command  Example: DllCall "AutoHotkey.dll\ahkExecuteLine", "PTR", LinePointer, "UInt", 0, "UInt", 0, "PTR"
                  DllCall "AutoHotkey.exe\ahkExecuteLine", "PTR", LinePointer, "UInt", 0, "UInt", 0, "PTR"

Function Example: LinePointer := DllCall("AutoHotkey.dll\ahkExecuteLine", "PTR", LinePointer, "UInt", 0, "UInt", 0, "PTR")
                  VarPointer := DllCall("AutoHotkey.exe\ahkExecuteLine", "PTR", LinePointer, "UInt", 0, "UInt", 0, "PTR")

Parameters

OutputVar

The name of variable in which to store the pointer to next line.

LinePointer

Pointer to Line to start execution from. NULL / false / 0 can be used to get pointer to first line.

Mode

0 - will not execute and return a pointer to next line only.
1 - UNTIL_RETURN
2 - UNTIL_BLOCK_END
3 - ONLY_ONE_LINE

Wait

1 (true) if you want to wait until execution finishes, else FALSE / NULL / 0.

Related

ahkFindFunc, ahkFindLabel, ahkassign, DllCall

Examples

MsgBox first Line %A_TickCount%
dll:=AhkThread("#Persistent`nMyVar:=`"Hello World!`"`nReturn`nMsgBox `% MyVar") ; start a new thread and set MyVar variable.
hLine:=0
Loop 3 ; Retrieve pointer to 4-th executable line.
 hLine := dll.ahkExecuteLine[hLine]
dll.ahkExecuteLine[hLine,1,1] ; execute from the 4-th line



; ---------------- Advanced Exaple ----------------

; AHK Structures
global _AHKDerefType := "LPTSTR marker,{_AHKVar *var,_AHKFunc *func,_AHKDerefType *next,UInt symbol},BYTE type,param_count,WORD length"
global _AHKExprTokenType := "{__int64 value_int64,double value_double,struct{{PTR *object,_AHKDerefType *deref,_AHKVar *var,LPTSTR marker},{LPTSTR buf,size_t marker_length}}},UINT symbol,{_AHKExprTokenType *circuit_token,LPTSTR mem_to_free}"
global _AHKArgStruct := "BYTE type,bool is_expression,WORD length,LPTSTR text,_AHKDerefType *deref,_AHKExprTokenType *postfix"
global _AHKBreakPoint := "INT id,BYTE type,BYTE state,bool temporary"
global _AHKLine := "BYTE mActionType,mArgc,WORD mFileIndex,UINT mLineNumber,_AHKArgStruct *mArg,PTR *mAttribute,_AHKLine *mPrevLine,*mNextLine,*mRelatedLine,*mParentLine,_AHKBreakPoint *mBreakPoint"
global _AHKLabel := "PTR vTable,LPTSTR mName,_AHKLine *mJumpToLine,_AHKLabel *mPrevLabel,*mNextLabel"
global _AHKFuncParam := "_AHKVar *var,WORD is_byref,default_type,{LPTSTR default_str,Int64 default_int64,Double default_double}"
If (A_PtrSize = 8)
	global _AHKRCCallbackFunc := "UINT64 data1,data2,PTR stub,UINT_PTR callfuncptr,BYTE actual_param_count,create_new_thread,event_info,*_AHKFunc func"
else
	global _AHKRCCallbackFunc := "ULONG data1,data2,data3,PTR stub,UINT_PTR callfuncptr,ULONG data4,data5,BYTE actual_param_count,create_new_thread,event_info,*_AHKFunc func"
global _AHKFunc := "PTR vTable,LPTSTR mName,{struct{_AHKLine *mJumpToLine,_AHKFuncParam *mParam,PTR *mClass},struct{PTR mBIF,UCHAR *mOutputVars,PTR mID}},Int mParamCount,MinParams,_AHKLabel *mFirstLabel,*mLastLabel,_AHKVar **mGlobalvar,**mVar,**mLazyVar,**mStaticVar,**mStaticLazyVar,Int mGlobalVarCount,mVarCount,mVarCountMax,mLazyVarCount,mStaticVarCount,mStaticLazyVarCount,Instances,UCHAR mDefaultVarType,bool mIsBuiltIn,mIsVariadic,mHasReturn"
global _AHKVar := "{Int64 mContentsInt64,Double mContentsDouble,PTR mobject,PTR mVV},{char *mByteContents,LPTSTR mCharContents},{UINT_PTR mLength,_AHKVar *mAliasFor},{UINT_PTR mCapacity,UINT_PTR mBIV},BYTE mHowAllocated,mAttrib,mScope,mType,LPTSTR mName"

hLine:=ahkExecuteLine() ; get pointer to first line in current script
mLine:=Struct(_AHKLine,hLine)

; Check if this is our script and correct line number as it might be included file or static line that is executes before script starts
While mLine.mFileIndex!=0 || mLine.mLineNumber!=1
  mLine[] := hLine := ahkExecuteLine(hLine) ; reassign next line and update Structure
ahkExecuteLine(hLine,3,1) ; execute first line in current thread