Skip to content

Commit f8f9441

Browse files
geppigeppi
authored
Documentation for the COM Record Support. (#2578)
1 parent 8258348 commit f8f9441

File tree

9 files changed

+397
-14
lines changed

9 files changed

+397
-14
lines changed

‎com/win32com/HTML/COM_Records.html‎

Lines changed: 382 additions & 0 deletions
Large diffs are not rendered by default.

‎com/win32com/HTML/GeneratedSupport.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<HTML>
22
<HEAD>
3-
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=windows-1252">
3+
<META HTTP-EQUIV="Content-Type" CONTENT="text/html" charset="utf-8">
44
<META NAME="Generator" CONTENT="Microsoft Word 97">
55
<TITLE>Generated Python COM Support</TITLE>
66
<META NAME="Version" CONTENT="8.0.3410">

‎com/win32com/HTML/PythonCOM.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<HTML>
22
<HEAD>
3-
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=windows-1252">
3+
<META HTTP-EQUIV="Content-Type" CONTENT="text/html" charset="utf-8">
44
<META NAME="Generator" CONTENT="Microsoft Word 97">
55
<TITLE>Untitled</TITLE>
66
<META NAME="Template" CONTENT="D:\Program Files\Microsoft Office\Office\html.dot">

‎com/win32com/HTML/QuickStartClientCom.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<HTML>
22
<HEAD>
3-
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=windows-1252">
3+
<META HTTP-EQUIV="Content-Type" CONTENT="text/html" charset="utf-8">
44
<META NAME="Generator" CONTENT="Microsoft Word 97">
55
<TITLE>Quick Start to Client side COM and Python</TITLE>
66
<META NAME="Template" CONTENT="D:\Program Files\Microsoft Office\Office\html.dot">

‎com/win32com/HTML/QuickStartServerCom.html‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<HTML>
22
<HEAD>
3-
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=windows-1252">
3+
<META HTTP-EQUIV="Content-Type" CONTENT="text/html" charset="utf-8">
44
<META NAME="Generator" CONTENT="Microsoft Word 97">
55
<TITLE>Quick Start to Server Side COM and Python</TITLE>
66
<META NAME="Version" CONTENT="8.0.3410">
@@ -39,7 +39,7 @@ <H3><A NAME="Using">Implement a stand-alone Python class with your functionality
3939

4040
</CODE><P>This is obviously a very simple server. In particular, custom error handling would be needed for a production class server. In addition, there are some contrived properties just for demonstration purposes.</P>
4141
<H3>Make Unicode concessions</H3>
42-
<P>At this stage, Python and Unicode don’t really work well together. All strings which come from COM will actually be Unicode objects rather than string objects.</P>
42+
<P>At this stage, Python and Unicode don't really work well together. All strings which come from COM will actually be Unicode objects rather than string objects.</P>
4343
<P>To make this code work in a COM environment, the last line of the "Hello" method must become:</P><DIR>
4444
<DIR>
4545
<DIR>
@@ -85,7 +85,7 @@ <H3>Annotate the class with win32com specific attributes</H3>
8585
<P>_public_attrs_ = ['softspace', 'noCalls']</P>
8686
<P>_readonly_attrs_ = ['noCalls']</P>
8787
<P>def __init__(self):</P>
88-
<P>[Same from here…]</P></DIR>
88+
<P>[Same from here...]</P></DIR>
8989
</DIR>
9090

9191
</CODE><H3><A NAME="Registering">Registering and assigning a CLSID for the object</A></H3>
@@ -179,7 +179,7 @@ <H2><A NAME="Exception">Exception Handling </A></H2>
179179
<H3>Default Policy attributes </H3>
180180
<P>The default policy object has a few special attributes that define who the object is exposed to COM. The example above shows the _public_methods attribute, but this section describes all such attributes in detail. </P>
181181
<H5>_public_methods_ </H5>
182-
<P>Required list of strings, containing the names of all methods to be exposed to COM. It is possible this will be enhanced in the future (eg, possibly '*' will be recognised to say all methods, or some other ideas…) </P>
182+
<P>Required list of strings, containing the names of all methods to be exposed to COM. It is possible this will be enhanced in the future (eg, possibly '*' will be recognised to say all methods, or some other ideas...) </P>
183183
<H5>_public_attrs_ </H5>
184184
<P>Optional list of strings containing all attribute names to be exposed, both for reading and writing. The attribute names must be valid instance variables. </P>
185185
<H5>_readonly_attrs_ </H5>

‎com/win32com/HTML/docindex.html‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<HTML>
22
<HEAD>
3-
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=windows-1252">
3+
<META HTTP-EQUIV="Content-Type" CONTENT="text/html" charset="utf-8">
44
<META NAME="Generator" CONTENT="Microsoft Word 97">
55
<TITLE>win32com Documentation Index</TITLE>
66
<META NAME="Template" CONTENT="D:\Program Files\Microsoft Office\Office\html.dot">
@@ -14,9 +14,10 @@ <H1>PythonCOM Documentation Index</H1>
1414
<P><A HREF="QuickStartServerCom.html">A Quick Start to Server Side COM</A></P>
1515
<P><A HREF="GeneratedSupport.html">Information on generated Python files (ie, what makepy generates)</A></P>
1616
<P><A HREF="variant.html">An advanced VARIANT object which can give more control over parameter types</A></P>
17+
<P><A HREF="COM_Records.html">COM Record Support</A></P>
1718
<P><A HREF="package.html">A brief description of the win32com package structure</A></P>
1819
<P><A HREF="PythonCOM.html">Python COM Implementation documentation</A></P>
19-
<P><A HREF="misc.html">Misc stuff I don’t know where to put anywhere else</A></P>
20+
<P><A HREF="misc.html">Misc stuff I don't know where to put anywhere else</A></P>
2021
<H3>ActiveX Scripting</H3>
2122
<P><A HREF="../../win32comext/axscript/demos/client/ie/demo.htm">ActiveX Scripting Demos</A></P></BODY>
2223
</HTML>

‎com/win32com/HTML/index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<HTML>
22
<HEAD>
3-
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=windows-1252">
3+
<META HTTP-EQUIV="Content-Type" CONTENT="text/html" charset="utf-8">
44
<META NAME="Generator" CONTENT="Microsoft Word 97">
55
<TITLE>win32com</TITLE>
66
<META NAME="Template" CONTENT="C:\Program Files\Microsoft Office\Office\html.dot">

‎com/win32com/HTML/misc.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<HTML>
22
<HEAD>
3-
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=windows-1252">
3+
<META HTTP-EQUIV="Content-Type" CONTENT="text/html" charset="utf-8">
44
<META NAME="Generator" CONTENT="Microsoft Word 97">
55
<TITLE>Misc win32com Stuff</TITLE>
66
<META NAME="Version" CONTENT="8.0.3410">
@@ -9,7 +9,7 @@
99
</HEAD>
1010
<BODY TEXT="#000000" BGCOLOR="#ffffff">
1111

12-
<H1>Misc stuff I don’t know where to put anywhere else</H1>
12+
<H1>Misc stuff I don't know where to put anywhere else</H1>
1313
<H4>Client Side Dispatch</H4>
1414
<P>Using win32com.client.Dispatch automatically invokes all the win32com client side "smarts", including automatic usage of generated .py files etc.</P>
1515
<P>If you wish to avoid that, and use truly "dynamic" objects (ie, there is generated .py support available, but you wish to avoid it), you can use win32com.client.dynamic.Dispatch</P>

‎com/win32com/HTML/package.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<HTML>
22
<HEAD>
3-
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=windows-1252">
3+
<META HTTP-EQUIV="Content-Type" CONTENT="text/html" charset="utf-8">
44
<META NAME="Generator" CONTENT="Microsoft Word 97">
55
<TITLE>The win32com package</TITLE>
66
<META NAME="Template" CONTENT="D:\Program Files\Microsoft Office\Office\html.dot">
@@ -32,6 +32,6 @@ <H2>The win32com package </H2>
3232
</FONT><P>&nbsp;</P>
3333
<H2>The pythoncom module </H2>
3434
<FONT SIZE=2><P>The pythoncom module is the underlying C++ support for all COM related objects. In general, Python programmers will not use this module directly, but use win32com helper classes and functions. </P>
35-
<P>This module exposes a C++ like interface to COM - there are objects implemented in pythoncom that have methods "QueryInterface()", "Invoke()", just like the C++ API. If you are using COM in C++, you would not call a method directly, you would use pObject-&gt;Invoke( …, MethodId, argArray…). Similarly, if you are using pythoncom directly, you must also use the Invoke method to call an object's exposed method.</FONT> </P>
35+
<P>This module exposes a C++ like interface to COM - there are objects implemented in pythoncom that have methods "QueryInterface()", "Invoke()", just like the C++ API. If you are using COM in C++, you would not call a method directly, you would use pObject-&gt;Invoke( ..., MethodId, argArray...). Similarly, if you are using pythoncom directly, you must also use the Invoke method to call an object's exposed method.</FONT> </P>
3636
<FONT SIZE=2><P>There are some Python wrappers for hiding this raw interface, meaning you should almost never need to use the pythoncom module directly. These helpers translate a "natural" looking interface (eg, obj.SomeMethod()) into the underlying Invoke call.</P></FONT></BODY>
3737
</HTML>

0 commit comments

Comments
 (0)