PageRenderTime 65ms CodeModel.GetById 34ms RepoModel.GetById 1ms app.codeStats 0ms

/docs/commands/ComObjQuery.htm

https://github.com/Lexikos/AutoHotkey_L-Docs
HTML | 123 lines | 97 code | 26 blank | 0 comment | 0 complexity | 2e530d50feba032dd8d9be8262b43be0 MD5 | raw file
    

  1. <!DOCTYPE HTML>
    2. 

  2. <html lang="en">
    3. 

  3. <head>
    4. 

  4. <title>ComObjQuery() - Syntax &amp; Usage | AutoHotkey</title>
    5. 

  5. <meta name="description" content="The ComObjQuery function queries a COM object for an interface or service." />
    6. 

  6. <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
    7. 

  7. <meta http-equiv="X-UA-Compatible" content="IE=edge">
    8. 

  8. <link href="../static/theme.css" rel="stylesheet" type="text/css" />
    9. 

  9. <script src="../static/content.js" type="text/javascript"></script>
    10. 

  10. </head>
    11. 

  11. <body>
    12. 

  12. 

  13. <h1>ComObjQuery() <span class="ver">[v1.0.96.00+]</span></h1>
    14. 

  14. <p>Queries a COM object for an interface or service.</p>
    15. 

  15. <pre class="Syntax">InterfacePointer := <span class="func">ComObjQuery</span>(ComObject, <span class="optional">SID,</span> IID)</pre>
    16. 

  16. 

  17. <h2 id="Parameters">Parameters</h2>
    18. 

  18. <dl>
    19. 

  19. 

  20.   <dt>ComObject</dt>
    21. 

  21.   <dd><p>A COM wrapper object or raw interface pointer.</p></dd>
    22. 

  22. 

  23.   <dt>IID</dt>
    24. 

  24.   <dd><p>An interface identifier (GUID) in the form "{xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}".</p></dd>
    25. 

  25. 

  26.   <dt>SID</dt>
    27. 

  27.   <dd><p>A service identifier in the same form as IID. When omitting this parameter, also omit the comma.</p></dd>
    28. 

  28. 

  29. </dl>
    30. 

  30. 

  31. <h2 id="General_Remarks">General Remarks</h2>
    32. 

  32. <p>In its two-parameter mode, this function is equivalent to <a href="http://msdn.microsoft.com/en-us/library/ms682521.aspx">IUnknown::QueryInterface</a>. When SID and IID are both specified, it internally queries for the <a href="http://msdn.microsoft.com/en-us/library/cc678965.aspx">IServiceProvider</a> interface, then calls <a href="http://msdn.microsoft.com/en-us/library/cc678966.aspx">IServiceProvider::QueryService</a>. In either case, the return value is either zero or a pointer to the requested interface. Generally this pointer must be <a href="ObjAddRef.htm">released</a> when the script is finished with it.</p>
    33. 

  33. 

  34. <h2 id="Related">Related</h2>
    35. 

  35. <a href="ObjAddRef.htm">ObjRelease()</a>, <a href="ComObjCreate.htm">ComObjCreate()</a>, <a href="ComObjGet.htm">ComObjGet()</a>, <a href="ComObjActive.htm">ComObjActive()</a>, <a href="ComObjError.htm">ComObjError()</a>
    36. 

  36. 

  37. <h2 id="Examples">Examples</h2>
    38. 

  38. <div class="ex" id="ExClassName">
    39. 

  39. <p><a class="ex_number" href="#ExClassName"></a> Determines the class name of an object.</p>
    40. 

  40. <pre>obj := ComObjCreate("Scripting.Dictionary")
    41. 

  41. 

  42. MsgBox % "Interface name: " ComObjType(obj, "name")
    43. 

  43. 

  44. IID_IProvideClassInfo := "{B196B283-BAB4-101A-B69C-00AA00341D07}"
    45. 

  45. 

  46. <em>; Request a pointer to the object's IProvideClassInfo interface.</em>
    47. 

  47. if !(pci := ComObjQuery(obj, IID_IProvideClassInfo))
    48. 

  48. {
    49. 

  49.     MsgBox IProvideClassInfo interface not supported.
    50. 

  50.     return
    51. 

  51. }
    52. 

  52. 

  53. <em>; Call GetClassInfo to retrieve a pointer to the ITypeInfo interface.</em>
    54. 

  54. DllCall(vtable(pci, 3), "ptr", pci, "ptr*", ti)
    55. 

  55. 

  56. <em>; Call GetDocumentation to get the object's full type name.</em>
    57. 

  57. DllCall(vtable(ti, 12), "ptr", ti, "int", -1, "ptr*", pname, "ptr", 0, "ptr", 0, "ptr", 0)
    58. 

  58. 

  59. <em>; Convert the BSTR pointer to a usable string.</em>
    60. 

  60. name := StrGet(pname, "UTF-16")
    61. 

  61. 

  62. <em>; Free the BSTR referenced by pname.</em>
    63. 

  63. DllCall("OleAut32\SysFreeString", "ptr", pname)
    64. 

  64. 

  65. <em>; Release raw interface pointers.</em>
    66. 

  66. ObjRelease(ti)
    67. 

  67. ObjRelease(pci)
    68. 

  68. 

  69. <em>; Display the type name!</em>
    70. 

  70. MsgBox % "Class name: " name
    71. 

  71. 

  72. vtable(ptr, n) {
    73. 

  73.     <em>; NumGet(ptr+0) returns the address of the object's virtual function
    74. 

  74.     ; table (vtable for short). The remainder of the expression retrieves
    75. 

  75.     ; the address of the nth function's address from the vtable.</em>
    76. 

  76.     return NumGet(NumGet(ptr+0), n*A_PtrSize)
    77. 

  77. }
    78. 

  78. </pre>
    79. 

  79. </div>
    80. 

  80. 

  81. <div class="ex" id="ExIE">
    82. 

  82. <p><a class="ex_number" href="#ExIE"></a> Automates an existing Internet Explorer window.</p>
    83. 

  83. <pre>sURL := "https://www.autohotkey.com/boards/"
    84. 

  84. if WebBrowser := GetWebBrowser()
    85. 

  85.     WebBrowser.Navigate(sURL)
    86. 

  86. return
    87. 

  87. 

  88. GetWebBrowser()
    89. 

  89. {
    90. 

  90.     <em>; Get a raw pointer to the document object of the top-most IE window.</em>
    91. 

  91.     static msg := DllCall("RegisterWindowMessage", "Str", "WM_HTML_GETOBJECT")
    92. 

  92.     SendMessage msg, 0, 0, Internet Explorer_Server1, ahk_class IEFrame
    93. 

  93.     if (ErrorLevel = "FAIL")
    94. 

  94.         return  <em>; IE not found.</em>
    95. 

  95.     lResult := ErrorLevel
    96. 

  96.     DllCall("oleacc\ObjectFromLresult", "Ptr", lResult
    97. 

  97.         , "Ptr", GUID(IID_IHTMLDocument2,"{332C4425-26CB-11D0-B483-00C04FD90119}")
    98. 

  98.         , "Ptr", 0, "Ptr*", pdoc)
    99. 

  99.     
    100. 

  100.     <em>; Query for the WebBrowserApp service. In this particular case,
    101. 

  101.     ; the SID and IID are the same, but it isn't always this way.</em>
    102. 

  102.     static IID_IWebBrowserApp := "{0002DF05-0000-0000-C000-000000000046}"
    103. 

  103.     static SID_SWebBrowserApp := IID_IWebBrowserApp
    104. 

  104.     pweb := ComObjQuery(pdoc, SID_SWebBrowserApp, IID_IWebBrowserApp)
    105. 

  105.     
    106. 

  106.     <em>; Release the document object pointer.</em>
    107. 

  107.     ObjRelease(pdoc)
    108. 

  108.     
    109. 

  109.     <em>; Return the WebBrowser object, wrapped for usability:</em>
    110. 

  110.     static VT_DISPATCH := 9, F_OWNVALUE := 1
    111. 

  111.     return ComObject(VT_DISPATCH, pweb, F_OWNVALUE)
    112. 

  112. }
    113. 

  113. 

  114. GUID(ByRef GUID, sGUID) <em>; Converts a string to a binary GUID and returns its address.</em>
    115. 

  115. {
    116. 

  116.     VarSetCapacity(GUID, 16, 0)
    117. 

  117.     return DllCall("ole32\CLSIDFromString", "WStr", sGUID, "Ptr", &amp;GUID) &gt;= 0 ? &amp;GUID : ""
    118. 

  118. }
    119. 

  119. </pre>
    120. 

  120. </div>
    121. 

  121. 

  122. </body>
    123. 

  123. </html>
    124. 

  124.