PageRenderTime 51ms CodeModel.GetById 23ms RepoModel.GetById 0ms app.codeStats 0ms

/AutoHotkey.docset/Contents/Resources/Documents/commands/ComObjType.htm

https://gitlab.com/ahkscript/Autohotkey.docset
HTML | 95 lines | 79 code | 16 blank | 0 comment | 0 complexity | 263e60db08853229842740e5981ecdcc MD5 | raw file
    

  1. <!DOCTYPE HTML>
    2. 

  2. <html>
    3. 

  3. <head>
    4. 

  4. <title>ComObjType()</title>
    5. 

  5. <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
    6. 

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

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

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

  9. </head>
    10. 

  10. <body>
    11. 

  11. 

  12. <h1>ComObjType() <span class="ver">[v1.0.91+]</span></h1>
    13. 

  13. 

  14. <p>Retrieves type information from a COM object.</p>
    15. 

  15. 

  16. <pre class="Syntax">VarType := ComObjType(ComObject)
    17. 

  17. Name    := ComObjType(ComObject, "Name")
    18. 

  18. IID     := ComObjType(ComObject, "IID")</pre>
    19. 

  19. 

  20. <h3>Parameters</h3>
    21. 

  21. <dl>
    22. 

  22. 

  23.   <dt>ComObject</dt>
    24. 

  24.   <dd><p>A wrapper object containing a COM object or typed value.</p></dd>
    25. 

  25. 

  26.   <dt>VarType</dt>
    27. 

  27.   <dd><p>An integer indicating the type of value. See below.</p></dd>
    28. 

  28. 

  29.   <dt>Name</dt>
    30. 

  30.   <dd><p>An interface type name.</p></dd>
    31. 

  31. 

  32.   <dt>IID</dt>
    33. 

  33.   <dd><p>A globally unique identifier (GUID) representing the interface type.</p></dd>
    34. 

  34. 

  35. </dl>
    36. 

  36. 

  37. <h3>Return Value</h3>
    38. 

  38. <p>If the second parameter is omitted, the variant type of the value contained by the wrapper object is returned.</p>
    39. 

  39. <p>If the second parameter is "Name" or "IID" and the wrapper object contains a COM object (variant type VT_DISPATCH), the COM object's type name or the identifier of its primary interface is returned.</p>
    40. 

  40. <p>If the parameters are invalid or an error occurs, an empty string is returned.</p>
    41. 

  41. 

  42. <h3 id="vt">Variant Type Constants</h3>
    43. 

  43. <pre>
    44. 

  44. VT_EMPTY     =      0  <em>; No value</em>
    45. 

  45. VT_NULL      =      1  <em>; SQL-style Null</em>
    46. 

  46. VT_I2        =      2  <em>; 16-bit signed int</em>
    47. 

  47. VT_I4        =      3  <em>; 32-bit signed int</em>
    48. 

  48. VT_R4        =      4  <em>; 32-bit floating-point number</em>
    49. 

  49. VT_R8        =      5  <em>; 64-bit floating-point number</em>
    50. 

  50. VT_CY        =      6  <em>; Currency</em>
    51. 

  51. VT_DATE      =      7  <em>; Date</em>
    52. 

  52. VT_BSTR      =      8  <em>; COM string (Unicode string with length prefix)</em>
    53. 

  53. VT_DISPATCH  =      9  <em>; COM object</em>
    54. 

  54. VT_ERROR     =    0xA  <em>; Error code (32-bit integer)</em>
    55. 

  55. VT_BOOL      =    0xB  <em>; Boolean True (-1) or False (0)</em>
    56. 

  56. VT_VARIANT   =    0xC  <em>; <a href="http://msdn.microsoft.com/en-us/library/ms221627.aspx">VARIANT</a> (must be combined with VT_ARRAY or VT_BYREF)</em>
    57. 

  57. VT_UNKNOWN   =    0xD  <em>; IUnknown interface pointer</em>
    58. 

  58. VT_DECIMAL   =    0xE  <em>; (not supported)</em>
    59. 

  59. VT_I1        =   0x10  <em>; 8-bit signed int</em>
    60. 

  60. VT_UI1       =   0x11  <em>; 8-bit unsigned int</em>
    61. 

  61. VT_UI2       =   0x12  <em>; 16-bit unsigned int</em>
    62. 

  62. VT_UI4       =   0x13  <em>; 32-bit unsigned int</em>
    63. 

  63. VT_I8        =   0x14  <em>; 64-bit signed int</em>
    64. 

  64. VT_UI8       =   0x15  <em>; 64-bit unsigned int</em>
    65. 

  65. VT_INT       =   0x16  <em>; Signed machine int</em>
    66. 

  66. VT_UINT      =   0x17  <em>; Unsigned machine int</em>
    67. 

  67. VT_RECORD    =   0x24  <em>; User-defined type -- NOT SUPPORTED</em>
    68. 

  68. VT_ARRAY     = 0x2000  <em>; <a href="http://msdn.microsoft.com/en-us/library/ms221482.aspx">SAFEARRAY</a></em>
    69. 

  69. VT_BYREF     = 0x4000  <em>; Pointer to another type of value</em>
    70. 

  70. <em>/*
    71. 

  71.  VT_ARRAY and VT_BYREF are combined with another value (using bitwise OR)
    72. 

  72.  to specify the exact type. For instance, 0x2003 identifies a <a href="http://msdn.microsoft.com/en-us/library/ms221482.aspx">SAFEARRAY</a>
    73. 

  73.  of 32-bit signed integers and 0x400C identifies a pointer to a <a href="http://msdn.microsoft.com/en-us/library/ms221627.aspx">VARIANT</a>.
    74. 

  74. */</em>
    75. 

  75. </pre>
    76. 

  76. 

  77. <h3>General Remarks</h3>
    78. 

  78. <p>In most common cases, return values from methods or properties of COM objects are converted to an appropriate data type supported by AutoHotkey. Types which aren't specifically handled are coerced to strings via <a href="http://msdn.microsoft.com/en-us/library/ms221258.aspx">VariantChangeType</a>; if this fails or if the variant type contains the VT_ARRAY or VT_BYREF flag, an object containing both the value and its type is returned instead.</p>
    79. 

  79. <p>For any variable <i>x</i>, if <code>ComObjType(x)</code> returns an integer, <i>x</i> contains a COM object wrapper.</p>
    80. 

  80. 

  81. 

  82. <h3>Related</h3>
    83. 

  83. <p><a href="ComObjValue.htm">ComObjValue</a>, <a href="ComObjCreate.htm">ComObjCreate</a>, <a href="ComObjGet.htm">ComObjGet</a>, <a href="ComObjActive.htm">ComObjActive</a></p>
    84. 

  84. 

  85. <h3>Examples</h3>
    86. 

  86. <pre class="NoIndent">
    87. 

  87. d := <a href="ComObjCreate.htm">ComObjCreate</a>("Scripting.Dictionary")
    88. 

  88. VarType := ComObjType(d)          <em>; Always 9 for script-callable objects.</em>
    89. 

  89. Name    := ComObjType(d, "Name")  <em>; Only valid for script-callable objects.</em>
    90. 

  90. IID     := ComObjType(d, "IID")   <em>; As above.</em>
    91. 

  91. MsgBox Variant type:`t%VarType%`nType name:`t%Name%`nInterface ID:`t%IID%
    92. 

  92. </pre>
    93. 

    94. 

  94. </body>
    95. 

  95. </html>
    96. 

    97.