Python for Win32 Extensions

https://mhammond.github.io/pywin32
Admin
Python for Win32 Extensions (pywin32) provides a set of Python extensions for Windows, offering...
Tokens:1,129,202
Snippets:18,224
Trust Score:8.3
Update:2 days ago
Show doc for...
Tokens:
Raw
### InstallModule

Source: https://mhammond.github.io/pywin32/isapi.install.html

Installs the extension.

```APIDOC
## InstallModule

### Description
Installs the extension.

### Method
Function

### Parameters
- **options** (object) - Required - Options for installation.

### Returns
None.
```

--------------------------------

### isapi.install.HandleCommandLine(params, argv=None, conf_module_name=None, default_arg='install', opt_parser=None, custom_arg_handlers={})

Source: https://mhammond.github.io/pywin32/isapi.install__HandleCommandLine_meth.html

Performs installation or removal of an ISAPI filter or extension. Handles standard command-line options and configuration information, and installs, removes, or updates the configuration of an ISAPI filter or extension.

```APIDOC
## isapi.install.HandleCommandLine

### Description
Performs installation or removal of an ISAPI filter or extension. Handles standard command-line options and configuration information, and installs, removes, or updates the configuration of an ISAPI filter or extension.

### Method
Function call

### Signature
HandleCommandLine(params, argv=None, conf_module_name=None, default_arg='install', opt_parser=None, custom_arg_handlers={})

### Parameters
- **params** (object) - Required - Configuration information for the ISAPI filter or extension.
- **argv** (list, optional) - Optional - Command-line arguments.
- **conf_module_name** (str, optional) - Optional - Configuration module name.
- **default_arg** (str, optional) - Optional - Default argument, defaults to 'install'.
- **opt_parser** (object, optional) - Optional - Option parser instance.
- **custom_arg_handlers** (dict, optional) - Optional - Custom argument handlers, defaults to {}.

### Comments
This module handles standard command-line options and configuration information, and installs, removes or updates the configuration of an ISAPI filter or extension. You must pass your configuration information in params - all other arguments are optional, and allow you to configure the installation process.
```

--------------------------------

### StartService

Source: https://mhammond.github.io/pywin32/win32service.html

Starts the specified service.

```APIDOC
## StartService

### Description
Starts the specified service.

### Method
N/A (SDK function)

### Parameters
None documented.

### Returns
None documented.
```

--------------------------------

### Run

Source: https://mhammond.github.io/pywin32/PyCWinThread.html

Starts the main application message pump.

```APIDOC
## Run

### Description
Starts the main application message pump.

### Method
Run

### Parameters
None

### Response
No return value documented.
```

--------------------------------

### Run

Source: https://mhammond.github.io/pywin32/PyCWinApp.html

Starts the main application message pump.

```APIDOC
## Run

### Description
Starts the main application message pump.

### Method
Run

### Parameters
None documented.
```

--------------------------------

### StartDoc

Source: https://mhammond.github.io/pywin32/PyCDC.html

Starts spooling a document to a printer DC.

```APIDOC
## StartDoc

### Description
Starts spooling a document to a printer DC.

### Method
N/A

### Endpoint
N/A

### Parameters
None documented.

### Request Example
N/A

### Response
N/A
```

--------------------------------

### GetSelection

Source: https://mhammond.github.io/pywin32/PyCSliderCtrl.html

Gets the selection start and end positions.

```APIDOC
## GetSelection

### Description
Gets the selection start and end positions.

### Method
GetSelection

### Parameters
None documented.

### Returns
A tuple containing the start and end positions.
```

--------------------------------

### isapi.install.GetWebServer(description=None)

Source: https://mhammond.github.io/pywin32/isapi.install__GetWebServer_meth.html

Loads the web server instance (COM object) for a given instance or description. If None is specified, the default website is retrieved (indicated by the identifier 1).

```APIDOC
## isapi.install.GetWebServer(description=None)

### Description
Loads the web server instance (COM object) for a given instance or description. If None is specified, the default website is retrieved (indicated by the identifier 1).

### Parameters
- **description** (optional) - The instance or description of the web server to load. If None, the default website is retrieved.

### Returns
The web server instance (COM object) for the specified description or the default website.
```

--------------------------------

### PyIProvideClassInfo2.GetGUID

Source: https://mhammond.github.io/pywin32/PyIProvideClassInfo2__GetGUID_meth.html

Gets the GUID for the object. The method accepts a flags parameter and returns a PyIID.

```APIDOC
## PyIProvideClassInfo2.GetGUID

### Description
Gets the GUID for the object.

### Method
GetGUID

### Parameters
- **flags** (int) - Required - The flags for the GUID.

### Returns
- **PyIID** - The GUID for the object.
```

--------------------------------

### Initialize

Source: https://mhammond.github.io/pywin32/PyIInitializeWithFile.html

Passes a file path to a property handler on startup.

```APIDOC
## Initialize

### Description
Passes a file path to a property handler on startup.

### Method
Initialize

### Parameters
None documented.

### Returns
None documented.
```

--------------------------------

### GetPriority

Source: https://mhammond.github.io/pywin32/PyITask__GetPriority_meth.html

Gets the priority that will be assigned to the process when the task starts. This method takes no parameters and returns an integer value.

```APIDOC
## GetPriority

### Description
Gets the priority that will be assigned to the process when the task starts.

### Method
GetPriority

### Parameters
None

### Returns
- **int** - The priority value assigned to the process when the task starts.

### Example
```python
priority = task.GetPriority()
```
```

--------------------------------

### win32gui.BeginPaint

Source: https://mhammond.github.io/pywin32/win32gui.html

Begins painting in a device context.

```APIDOC
## BeginPaint

### Description
Begins painting in a device context.

### Method
BeginPaint

### Parameters
No parameters documented.

### Returns
No return value documented.
```

--------------------------------

### StartServiceCtrlDispatcher

Source: https://mhammond.github.io/pywin32/servicemanager.html

Starts the service by calling the win32 StartServiceCtrlDispatcher function.

```APIDOC
## StartServiceCtrlDispatcher

### Description
Starts the service by calling the win32 StartServiceCtrlDispatcher function.

### Method
N/A (Module function)

### Parameters
None documented.

### Request Example
N/A

### Response
N/A
```

--------------------------------

### win32clipboard.EnumClipboardFormats

Source: https://mhammond.github.io/pywin32/win32clipboard__EnumClipboardFormats_meth.html

Enumerates the data formats currently available on the clipboard. Call with format=0 to start enumeration, then pass the previous return value to get the next format. Returns zero when no more formats are available.

```APIDOC
## win32clipboard.EnumClipboardFormats

### Description
Enumerates the data formats currently available on the clipboard. Call with format=0 to start enumeration, then pass the previous return value to get the next format. Returns zero when no more formats are available.

### Method
Function call

### Signature
int = EnumClipboardFormats(_format_)

### Parameters
- **_format** (int) - Optional - Specifies a clipboard format that is known to be available. To start an enumeration, set to zero. For subsequent calls, set to the result of the previous EnumClipboardFormats call.

### Return Value
- **int** - If successful, returns the next available clipboard format. If there are no more formats, returns zero. On failure, raises win32api.error with GetLastError info.

### Remarks
- The clipboard must be opened using OpenClipboard before calling this function.
- Formats are enumerated in the order they were placed on the clipboard.
- The system may provide automatic type conversions for certain formats, which are also enumerated.

### Example
```python
import win32clipboard

win32clipboard.OpenClipboard()
fmt = 0
while True:
    fmt = win32clipboard.EnumClipboardFormats(fmt)
    if fmt == 0:
        break
    print(fmt)
win32clipboard.CloseClipboard()
```
```

--------------------------------

### Initialize Word Application with Static Dispatch

Source: https://mhammond.github.io/pywin32/html/com/win32com/HTML/QuickStartClientCom.html

Example of importing win32com.client and dispatching a Word application object after generating support.

```python
>>> import win32com.client
 
>>> w=win32com.client.Dispatch("Word.Application")
 
>>> w.Visible=1
 
>>> w
 
<win32com.gen_py.Microsoft Word 8.0 Object Library._Application>
```

--------------------------------

### GetPRINTDLGMinPage

Source: https://mhammond.github.io/pywin32/PyCPrintInfo.html

Gets the minimum value for the page range specified in the From and To page edit controls. If nMinPage equals nMaxPage, the Pages radio button and the starting and ending page edit controls are disabled.

```APIDOC
## GetPRINTDLGMinPage

### Description
Gets the minimum value for the page range specified in the From and To page edit controls. If nMinPage equals nMaxPage, the Pages radio button and the starting and ending page edit controls are disabled.

### Method
GetPRINTDLGMinPage

### Parameters
None documented.
```

--------------------------------

### PyIShellExtInit.Initialize

Source: https://mhammond.github.io/pywin32/PyIShellExtInit__Initialize_meth.html

Initializes the shell extension with the specified folder, data object, and registry key.

```APIDOC
## PyIShellExtInit.Initialize

### Description
Initializes the shell extension with the specified folder, data object, and registry key.

### Method
Initialize

### Parameters
- **_pFolder_** (PyIDL) - Required - Description for pFolder
- **_pDataObject_** (PyIDataObject) - Required - Description for pDataObject
- **_hkey_** (PyHANDLE) - Required - Description for hkey

```

--------------------------------

### Start

Source: https://mhammond.github.io/pywin32/PyIDebugExpression.html

Starts the debug expression evaluation.

```APIDOC
## Start

### Description
Starts the debug expression evaluation.

### Method
Start

### Endpoint
PyIDebugExpression.Start

### Parameters
None

### Request Example
None

### Response
#### Success Response
None

#### Response Example
None
```

--------------------------------

### Initializing win32ui in InitInstance

Source: https://mhammond.github.io/pywin32/html/pythonwin/doc/EmbeddingWin32ui.html

Shows how to call DynamicApplicationInit within the CWinApp::InitInstance method to attach the Python win32ui extensions.

```cpp
BOOL GameApp::InitInstance()
{
...
  if (!glue.DynamicApplicationInit("import initscore", csScripts)) {
  // Assuming you have a ReportError method - do whatever makes sense!
    ReportError("Could not attach to the Python win32ui extensions");
    return FALSE;
  }
... 
```

--------------------------------

### Create a COM Record using GUIDs

Source: https://mhammond.github.io/pywin32/html/com/win32com/HTML/COM_Records.html

Use pythoncom.GetRecordFromGuids to instantiate a COM Record when the Type Library GUID and record GUID are known.

```python
import pythoncom

PyCOMTestLib_GUID = '{6bcdcb60-5605-11d0-ae5f-cadd4c000000}'
MAJVER = 1
MINVER = 1
LCID = 0
TestStruct1_GUID = '{7a4ce6a7-7959-4e85-a3c0-b41442ff0f67}'

record1 = pythoncom.GetRecordFromGuids(PyCOMTestLib_GUID, MAJVER, MINVER, LCID, TestStruct1_GUID)
```

--------------------------------

### Start(_pdecb_)

Source: https://mhammond.github.io/pywin32/PyIDebugExpression__Start_meth.html

Starts the debug expression evaluation with the provided callback.

```APIDOC
## Start(_pdecb_)

### Description
Starts the debug expression evaluation.

### Method
Start

### Parameters
#### _pdecb_ : PyIDebugExpressionCallBack
- Required - Description for pdecb

```

--------------------------------

### InstallModule(conf_module_name, params, options, log)

Source: https://mhammond.github.io/pywin32/isapi.install__InstallModule_meth.html

Installs the ISAPI extension. The function accepts a configuration module name, parameters, options, and an optional logging function.

```APIDOC
## InstallModule(conf_module_name, params, options, log)

### Description
Installs the extension. This function is part of the isapi.install module and is used to install an ISAPI extension.

### Parameters
- **conf_module_name** (string) - Required - The name of the configuration module.
- **params** (object) - Required - Parameters for the installation.
- **options** (object) - Required - Options for the installation.
- **log** (function) - Optional - A logging function. Default is a lambda function.

### Returns
No return value is documented.
```

--------------------------------

### AfxOleInit

Source: https://mhammond.github.io/pywin32/win32uiole.html

Initializes the OLE libraries for the application.

```APIDOC
## AfxOleInit

### Description
Initializes the OLE libraries for the application.

### Method
Function

### Parameters
None

### Return Value
None
```

--------------------------------

### get

Source: https://mhammond.github.io/pywin32/PyIADs.html

Synonym for Get, retrieves a specific property value from the ADSI object.

```APIDOC
## get

### Description
Synonym for Get, retrieves a specific property value from the ADSI object.

### Method
get

### Parameters
None

### Response
Returns the property value.
```

--------------------------------

### Initial Hello Method Implementation

Source: https://mhammond.github.io/pywin32/html/com/win32com/HTML/QuickStartServerCom.html

A simple implementation of the Hello method for a COM server.

```python
# insert "softspace" number of spaces
 
return "Hello" + " " * self.softspace + who
```

--------------------------------

### PyCRichEditCtrl.SetSel(start, end)

Source: https://mhammond.github.io/pywin32/PyCRichEditCtrl__SetSel_meth.html

Sets the selection in the edit control. The start parameter specifies the starting position, and the end parameter specifies the ending position. Special values: start=0 and end=-1 selects all text; start=-1 removes any current selection.

```APIDOC
## PyCRichEditCtrl.SetSel(start, end)

### Description
Sets the selection in the edit control.

### Method
SetSel

### Parameters
- **start** (int) - Required - Specifies the starting position. If start is 0 and end is -1, all the text in the edit control is selected. If start is -1, any current selection is removed.
- **end** (int) - Optional - Specifies the ending position. Defaults to start.

### Alternative Parameters
- **start, end** - As for normal start, end args.

### MFC References
CRichEditCtrl::SetSel
```

--------------------------------

### win32file.SetupComm(handle, dwInQueue, dwOutQueue)

Source: https://mhammond.github.io/pywin32/win32file__SetupComm_meth.html

Initializes the communications parameters for a specified communications device. The function takes a handle to the device and recommended sizes for the internal input and output buffers.

```APIDOC
## win32file.SetupComm(handle, dwInQueue, dwOutQueue)

### Description
Initializes the communications parameters for a specified communications device.

### Parameters
- **handle** (PyHANDLE) - Required - The handle to the communications device.
- **dwInQueue** (int) - Required - Specifies the recommended size, in bytes, of the device's internal input buffer.
- **dwOutQueue** (int) - Required - Specifies the recommended size, in bytes, of the device's internal output buffer.

### Return Value
No return value is documented.
```

--------------------------------

### FireDebuggerEvent(guid, unknown)

Source: https://mhammond.github.io/pywin32/PyIDebugApplication__FireDebuggerEvent_meth.html

Fires a generic event to the IApplicationDebugger (if any). The method takes a GUID and an unknown object as parameters.

```APIDOC
## FireDebuggerEvent(guid, unknown)

### Description
Fires a generic event to the IApplicationDebugger (if any).

### Method
FireDebuggerEvent

### Parameters
- **guid** (PyIIID) - Required - A GUID.
- **unknown** (PyIUnknown) - Required - An unknown object.

### Return Value
No return value is documented.
```

--------------------------------

### Initialize Debug Output and Application Setup in initscore.py

Source: https://mhammond.github.io/pywin32/html/pythonwin/doc/EmbeddingWin32ui.html

This snippet demonstrates redirecting Python output to the MSVC debugger and setting up the initial application environment.

```python
import sys
import win32ui
# First step - redirect python output to the debugging device, until we
# can create a window to capture it.

# Note that this is only useful while debugging, and simply sends any
# Python output (ie, exceptions while developing the startup code) is
# printed to the MSVC debugger. Note that since this code was written,
# the win32trace module has appeared, giving another alternative to
# debugging this code.
class DebugOutput:
  softspace=1
  def write(self,message):
    win32ui.OutputDebug(message)
sys.stderr=sys.stdout=DebugOutput()

# One of your first priorities should be to set sys.stdout to somewhere useful,
# depending on what useful means to your application. This code simply creates
# the Pythonwin Interactive Window, which handles this automatically.

# Now here is the code that does the real work.
import win32con 

from pywin.framework import intpyapp, app
```

```python
class ScoreApp(intpyapp.InteractivePythonApp):
  def InitInstance(self):
    # Call the base class (if you want)
    intpyapp.InteractivePythonApp.InitInstance(self)
    # Do domething useful, specific to your app.
    # Here, we minimise the interactive window.
    # (after painting the main frame)
    win32ui.PumpWaitingMessages()
    interact.edit.currentView.GetParent().ShowWindow(win32con.SW_MINIMIZE)

#  def OnExitInstance(self):
#    return 0

app = ScoreApp()
```

--------------------------------

### SetGuid(_guid_)

Source: https://mhammond.github.io/pywin32/PyICreateTypeLib__SetGuid_meth.html

Sets the GUID for the type library. The _guid_ parameter is a PyIID object representing the GUID to set.

```APIDOC
## SetGuid(_guid_)

### Description
Sets the GUID for the type library.

### Method
SetGuid

### Parameters
- **_guid_** (PyIID) - Required - Description for guid

### Returns
None
```

--------------------------------

### SetGuid(_guid_)

Source: https://mhammond.github.io/pywin32/PyICreateTypeLib2__SetGuid_meth.html

Sets the GUID for the type library. The _guid_ parameter is a PyIID object representing the GUID to assign.

```APIDOC
## SetGuid(_guid_)

### Description
Sets the GUID for the type library.

### Method
SetGuid

### Parameters
- **_guid_** (PyIID) - Required - The GUID to set for the type library.

### Return Value
None documented.
```

--------------------------------

### servicemanager.PrepareToHostSingle(_klass_)

Source: https://mhammond.github.io/pywin32/servicemanager__PrepareToHostSingle_meth.html

Prepares the executable to host a single service. The optional _klass_ parameter specifies the Python class to host; if omitted, the service name is looked up in the registry and the class is instantiated.

```APIDOC
## servicemanager.PrepareToHostSingle(_klass_)

### Description
Prepares the executable to host a single service. If a class is provided, it is used as the service class; otherwise, the service name is looked up in the registry and the specified class is instantiated.

### Method
PrepareToHostSingle

### Parameters
- **_klass_** (object) - Optional - The Python class to host. If not specified, the service name is looked up in the registry and the specified class instantiated.

### Returns
None

```

--------------------------------

### Invoke pywin32_postinstall as a console script

Source: https://mhammond.github.io/pywin32/html/CHANGES.md

The postinstall script can be executed via the command line using these two methods.

```bash
python -m pywin32_postinstall -install
```

```bash
pywin32_postinstall -install
```

--------------------------------

### Use get method with defaults

Source: https://mhammond.github.io/pywin32/win32timezone.RangeMap.html

Shows how to use the get method to provide a default value when a key is not found.

```python
>>> r.get(0, 'not found')

'not found'


>>> r.get(7, 'not found')

'not found'
```

--------------------------------

### FindText

Source: https://mhammond.github.io/pywin32/PyCRichEditCtrl__FindText_meth.html

Finds text in the control starting from the specified character position. Returns an integer and a tuple of start and end positions.

```APIDOC
## FindText

### Description
Finds text in the control.

### Method
FindText

### Parameters
- **_charPos_** (int) - Required - The character position.

### Returns
- **int** - An integer result.
- **(start, end)** - A tuple of start and end positions.
```

--------------------------------

### Capture audio with DirectSound

Source: https://mhammond.github.io/pywin32/DirectSound_examples.html

This example demonstrates how to capture audio into a buffer, save it to a file, and prepend a valid WAV header.

```python
import pywintypes

import struct

import win32event

import win32com.directsound.directsound as ds



def wav_header_pack(wfx, datasize):

    return struct.pack('<4sl4s4slhhllhh4sl', 'RIFF', 36 + datasize,

		       'WAVE', 'fmt ', 16,

		       wfx.wFormatTag, wfx.nChannels, wfx.nSamplesPerSec,

		       wfx.nAvgBytesPerSec, wfx.nBlockAlign,

		       wfx.wBitsPerSample, 'data', datasize);



d = ds.DirectSoundCaptureCreate(None, None)



sdesc = ds.DSCBUFFERDESC()
sdesc.dwBufferBytes = 352800 # 2 seconds
sdesc.lpwfxFormat = pywintypes.WAVEFORMATEX()
sdesc.lpwfxFormat.wFormatTag = pywintypes.WAVE_FORMAT_PCM
sdesc.lpwfxFormat.nChannels = 2
sdesc.lpwfxFormat.nSamplesPerSec = 44100
sdesc.lpwfxFormat.nAvgBytesPerSec = 176400
sdesc.lpwfxFormat.nBlockAlign = 4
sdesc.lpwfxFormat.wBitsPerSample = 16



buffer = d.CreateCaptureBuffer(sdesc)



event = win32event.CreateEvent(None, 0, 0, None)
notify = buffer.QueryInterface(ds.IID_IDirectSoundNotify)



notify.SetNotificationPositions((ds.DSBPN_OFFSETSTOP, event))



buffer.Start(0)



win32event.WaitForSingleObject(event, -1)



# in real life, more, smaller buffers should be retrieved
data = buffer.Update(0, 352800)



f = open('recording.wav', 'wb')
f.write(wav_header_pack(sdesc.lpwfxFormat, 352800))
f.write(data)
```

--------------------------------

### SetGuid(_guid_)

Source: https://mhammond.github.io/pywin32/PyICreateTypeInfo__SetGuid_meth.html

Sets the GUID for the type information object. The _guid_ parameter is a PyIID object representing the GUID to set.

```APIDOC
## SetGuid(_guid_)

### Description
Sets the GUID for the type information object.

### Method
SetGuid

### Parameters
- **_guid_** (PyIID) - Required - Description for guid

### Returns
No return value is documented.
```

--------------------------------

### servicemanager.PrepareToHostMultiple(service_name, klass)

Source: https://mhammond.github.io/pywin32/servicemanager__PrepareToHostMultiple_meth.html

Prepares the executable to host multiple Windows services. The service_name parameter is the name of the service hosted by the class, and klass is the Python class to host.

```APIDOC
## servicemanager.PrepareToHostMultiple(service_name, klass)

### Description
Prepares the executable to host multiple Windows services. This function is called to register a service class and its associated service name for hosting in the current executable.

### Method
Function call

### Endpoint
servicemanager.PrepareToHostMultiple

### Parameters
#### Parameters
- **service_name** (string) - Required - The name of the service hosted by the class.
- **klass** (object) - Required - The Python class to host.

### Request Example
No request body is applicable for this function call.

### Response
#### Success Response
No return value is documented.

#### Response Example
No response example is provided in the source.
```

--------------------------------

### CreateCategory(guid, riid)

Source: https://mhammond.github.io/pywin32/PyICategoryProvider__CreateCategory_meth.html

Creates a new category with the specified GUID and interface ID. This method is part of the PyICategoryProvider interface.

```APIDOC
## CreateCategory(guid, riid)

### Description
Creates a new category with the specified GUID and interface ID.

### Method
CreateCategory

### Parameters
- **guid** (PyIID) - Required - Description for pguid
- **riid** (PyIID) - Required - Description for riid

### Returns
No return value is documented.
```

--------------------------------

### CreateDesktop

Source: https://mhammond.github.io/pywin32/win32service.html

Creates a new desktop in calling process's current window station.

```APIDOC
## CreateDesktop

### Description
Creates a new desktop in calling process's current window station.

### Method
N/A (SDK function)

### Parameters
None documented.

### Returns
Handle to the new desktop.
```

--------------------------------

### Init

Source: https://mhammond.github.io/pywin32/PyIQueryAssociations.html

Initializes the IQueryAssociations interface and sets the root key to the appropriate ProgID.

```APIDOC
## Init

### Description
Initializes the IQueryAssociations interface and sets the root key to the appropriate ProgID.

### Method
Init

### Parameters
None documented.

### Response
No return value documented.
```

--------------------------------

### Getting and modifying user information

Source: https://mhammond.github.io/pywin32/html/com/help/adsi.html

Shows how to retrieve and update user attributes using Get, Put, and Setinfo methods.

```python
ex_path="LDAP://server/cn=fredflint,cn=Recipients,ou=rubble,o=bedrock" myDSObject = ldap.OpenDSObject(ex_path,logon_ex,password,0) myDSObject.Getinfo() # To access a user's data try: attribute = myDSObject.Get('Extension-Attribute-1') print(attribute) # To modify a user try: myDSObject.Put('Extension-Attribute-1','barney was here') myDSObject.Setinfo()
```

--------------------------------

### AddAccessAllowedObjectAce

Source: https://mhammond.github.io/pywin32/PyACL__AddAccessAllowedObjectAce_meth.html

Adds an ACCESS_ALLOWED_OBJECT_ACE to the ACL with specified revision, flags, access mask, object type GUID, inherited object type GUID, and SID.

```APIDOC
## AddAccessAllowedObjectAce

### Description
Adds an ACCESS_ALLOWED_OBJECT_ACE to the ACL.

### Method
AddAccessAllowedObjectAce

### Parameters
- **AceRevision** (int) - Required - Must be at least ACL_REVISION_DS
- **AceFlags** (int) - Required - Combination of ACE inheritance flags (CONTAINER_INHERIT_ACE, INHERIT_ONLY_ACE, INHERITED_ACE, NO_PROPAGATE_INHERIT_ACE, and OBJECT_INHERIT_ACE)
- **AccessMask** (int) - Required - Specifies the mask of access rights to be granted to the specified SID
- **ObjectTypeGuid** (PyIID) - Required - GUID of object type or property set to which ace applies, can be None
- **InheritedObjectTypeGuid** (PyIID) - Required - GUID of object type or property that will inherit ACE, can be None
- **sid** (PySID) - Required - A SID object representing a user, group, or logon account being granted access.

### Return Value
No return value is documented.
```

--------------------------------

### win32service.CreateWindowStation

Source: https://mhammond.github.io/pywin32/win32service__CreateWindowStation_meth.html

Creates a new window station and returns a handle to it.

```APIDOC
## win32service.CreateWindowStation

### Description
Creates a new window station and returns a handle to it.

### Function Signature
PyHWINSTA = CreateWindowStation(_WindowStation_, _Flags_, _DesiredAccess_, _SecurityAttributes_)

### Parameters
- **_WindowStation_** (string) - Required - Name of window station to create, or None.
- **_Flags_** (int) - Required - CWF_CREATE_ONLY or 0.
- **_DesiredAccess_** (int) - Required - Bitmask of access types available to returned handle.
- **_SecurityAttributes_** (PySECURITY_ATTRIBUTES) - Required - Specifies security for window station, and whether handle is inheritable.

### Return Value
PyHWINSTA - Handle to the created window station.

### Comments
If name is None or empty string, name is formatted from logon id.
```

--------------------------------

### PSLookupPropertyHandlerCLSID

Source: https://mhammond.github.io/pywin32/propsys__PSLookupPropertyHandlerCLSID_meth.html

Returns the GUID of the property handler for a file. The function takes a file path as input and returns a PyIID object representing the property handler's GUID.

```APIDOC
## PSLookupPropertyHandlerCLSID

### Description
Returns the GUID of the property handler for a file.

### Parameters
- **_FilePath_** (str) - Required - Name of file.

### Returns
- **PyIID** - The GUID of the property handler.

### Comments
If no handler is found, the returned error code can be deceptive as it seems to indicate that the file itself was not found.
```

--------------------------------

### Automating Excel via COM

Source: https://mhammond.github.io/pywin32/html/com/win32com/HTML/QuickStartClientCom.html

Example of launching Excel, making it visible, adding a workbook, and setting a cell value.

```python
o = win32com.client.Dispatch("Excel.Application")  
 o.Visible = 1  
 o.Workbooks.Add()  
 o.Cells(1,1).Value = "Hello"
```

--------------------------------

### GetResource

Source: https://mhammond.github.io/pywin32/win32ui.html

Gets a resource.

```APIDOC
## GetResource

### Description
Gets a resource.

### Method
N/A (SDK method)

### Parameters
Not specified in source.

### Returns
Resource object.
```

--------------------------------

### GetMenuItemInfo

Source: https://mhammond.github.io/pywin32/win32gui.html

Gets menu information.

```APIDOC
## GetMenuItemInfo

### Description
Gets menu information.

### Method
GetMenuItemInfo

### Parameters
No parameters documented.

### Return Value
No return value documented.
```

--------------------------------

### PyCView.DoPreparePrinting

Source: https://mhammond.github.io/pywin32/PyCView__DoPreparePrinting_meth.html

Invokes the Print dialog box and creates a printer device context. Returns an integer.

```APIDOC
## PyCView.DoPreparePrinting

### Description
Invokes the Print dialog box and creates a printer device context.

### Method
DoPreparePrinting

### Signature
int = DoPreparePrinting()

### Parameters
None

### Return Value
- **int** - The return value of the method.

### Remarks
Related to PyCView.OnPreparePrinting.
```

--------------------------------

### GetForegroundWindow

Source: https://mhammond.github.io/pywin32/win32gui.html

Gets the foreground window.

```APIDOC
## GetForegroundWindow

### Description
Gets the foreground window.

### Method
N/A (SDK function)

### Parameters
Not specified in source.

### Returns
Not specified in source.
```

--------------------------------

### SwitchDesktop

Source: https://mhammond.github.io/pywin32/PyHDESK.html

Activates the desktop.

```APIDOC
## SwitchDesktop

### Description
Activates the desktop.

### Method
N/A (SDK method)

### Parameters
None

### Returns
None

```

--------------------------------

### GetActiveWindow

Source: https://mhammond.github.io/pywin32/win32gui.html

Gets the active window.

```APIDOC
## GetActiveWindow

### Description
Gets the active window.

### Method
N/A (SDK function)

### Parameters
Not specified in source.

### Returns
Not specified in source.
```

--------------------------------

### win32service.CreateDesktop

Source: https://mhammond.github.io/pywin32/win32service__CreateDesktop_meth.html

Creates a new desktop in the calling process's current window station and returns a handle to it.

```APIDOC
## win32service.CreateDesktop

### Description
Creates a new desktop in the calling process's current window station and returns a handle to the created desktop.

### Function Signature
PyHDESK = CreateDesktop(Desktop, Flags, DesiredAccess, SecurityAttributes)

### Parameters
- **Desktop** (string) - Required - Name of desktop to create.
- **Flags** (int) - Required - DF_ALLOWOTHERACCOUNTHOOK or 0.
- **DesiredAccess** (int) - Required - An ACCESS_MASK determining level of access available through returned handle.
- **SecurityAttributes** (PySECURITY_ATTRIBUTES) - Required - Specifies inheritance and controls access to desktop.

### Return Value
- **PyHDESK** - Handle to the created desktop.
```

--------------------------------

### GetDoubleClickTime

Source: https://mhammond.github.io/pywin32/win32gui.html

Gets the double-click time.

```APIDOC
## GetDoubleClickTime

### Description
Gets the double-click time.

### Method
N/A (SDK function)

### Parameters
Not specified in source.

### Returns
Not specified in source.
```

--------------------------------

### GetWindowText

Source: https://mhammond.github.io/pywin32/win32gui.html

Get the window text.

```APIDOC
## GetWindowText

### Description
Get the window text.

### Method
N/A (Module function)

### Parameters
None documented.

### Returns
None documented.
```

--------------------------------

### win32process.GetStartupInfo

Source: https://mhammond.github.io/pywin32/win32process__GetStartupInfo_meth.html

Retrieves the contents of the STARTUPINFO structure that was specified when the calling process was created. This function takes no arguments and returns a PySTARTUPINFO object.

```APIDOC
## win32process.GetStartupInfo

### Description
Retrieves the contents of the STARTUPINFO structure that was specified when the calling process was created.

### Method
Function call

### Endpoint
win32process.GetStartupInfo()

### Parameters
None

### Return Value
- **PySTARTUPINFO** - The STARTUPINFO structure of the calling process.

### Example
```python
import win32process
startup_info = win32process.GetStartupInfo()
```
```

--------------------------------

### PyIQueryAssociations.Init

Source: https://mhammond.github.io/pywin32/PyIQueryAssociations__Init_meth.html

Initializes the IQueryAssociations interface and sets the root key to the appropriate ProgID.

```APIDOC
## PyIQueryAssociations.Init

### Description
Initializes the IQueryAssociations interface and sets the root key to the appropriate ProgID.

### Method
Init

### Signature
Init(_flags_, _assoc_, _hkeyProgId=None_, _hwnd=None_)

### Parameters
- **flags** (int) - Required - One of shellcon.ASSOCF_* flags
- **assoc** (string) - Required - The string data (ie, extension, prog-id, etc)
- **hkeyProgId** (PyHKEY) - Optional - Root registry key, can be None
- **hwnd** (PyHANDLE) - Optional - Reserved, must be 0 or None

### Return Value
No return value is documented.
```

--------------------------------

### GetPropList

Source: https://mhammond.github.io/pywin32/PyIMAPIProp.html

Gets a list of properties.

```APIDOC
## GetPropList

### Description
Gets a list of properties.

### Method
GetPropList

### Parameters
None documented.

### Response
Returns a list of properties.
```

--------------------------------

### win32gui.BeginPath

Source: https://mhammond.github.io/pywin32/win32gui.html

Initializes a path in a DC.

```APIDOC
## BeginPath

### Description
Initializes a path in a DC.

### Method
BeginPath

### Parameters
No parameters documented.

### Returns
No return value documented.
```

--------------------------------

### GetTextLen

Source: https://mhammond.github.io/pywin32/PyCListBox.html

Gets the length of an item.

```APIDOC
## GetTextLen

### Description
Get the length of an item.

### Method
GetTextLen

### Parameters
None documented.

### Returns
None documented.
```

--------------------------------

### InstallCallbackCaller

Source: https://mhammond.github.io/pywin32/win32ui.html

Installs a callback caller.

```APIDOC
## InstallCallbackCaller

### Description
Installs a callback caller.

### Method
N/A (SDK method)

### Parameters
Not specified in source.

### Returns
None.
```

--------------------------------

### win32gui.BeginPath

Source: https://mhammond.github.io/pywin32/win32gui__BeginPath_meth.html

Initializes a path in a device context. The function takes a handle to a device context and returns None.

```APIDOC
## win32gui.BeginPath

### Description
Initializes a path in a device context.

### Method
Function call

### Signature
BeginPath(_hdc_)

### Parameters
- **_hdc_** (PyHANDLE) - Required - Handle to a device context.

### Return Value
None

### Remarks
This function is a wrapper for the Windows GDI BeginPath function.
```

--------------------------------

### CreateWindowStation

Source: https://mhammond.github.io/pywin32/win32service.html

Creates a new window station.

```APIDOC
## CreateWindowStation

### Description
Creates a new window station.

### Method
N/A (SDK function)

### Parameters
None documented.

### Returns
Handle to the new window station.
```

--------------------------------

### StartDebuggerPump

Source: https://mhammond.github.io/pywin32/win32ui.html

Starts the debugger message pump.

```APIDOC
## StartDebuggerPump

### Description
Starts the debugger message pump.

### Method
N/A (SDK method)

### Parameters
None

### Returns
None.
```

--------------------------------

### GetTransactionId

Source: https://mhammond.github.io/pywin32/win32transaction.html

Returns the transaction's GUID.

```APIDOC
## GetTransactionId

### Description
Returns the transaction's GUID.

### Method
GetTransactionId

### Parameters
- **transactionHandle** (handle) - Required - Handle to the transaction.

### Returns
The transaction's GUID.
```

--------------------------------

### SetupComm

Source: https://mhammond.github.io/pywin32/win32file.html

Initializes the communications parameters for a specified communications device.

```APIDOC
## SetupComm

### Description
Initializes the communications parameters for a specified communications device.

### Method
SetupComm

### Parameters
None documented.

### Response
None documented.
```

--------------------------------

### STARTUPINFO

Source: https://mhammond.github.io/pywin32/win32process.html

Creates a new STARTUPINFO object used for process creation.

```APIDOC
## STARTUPINFO

### Description
Creates a new STARTUPINFO object.

### Method
Constructor

### Parameters
None

### Returns
A new STARTUPINFO object.
```

--------------------------------

### CreateGuid

Source: https://mhammond.github.io/pywin32/pywintypes.html

Creates a new, unique GUID.

```APIDOC
## CreateGuid

### Description
Creates a new, unique GUID.

### Method
Function

### Parameters
None

### Returns
- **guid** (PyIID) - A new, unique GUID.
```

--------------------------------

### PyIInitializeWithFile.Initialize

Source: https://mhammond.github.io/pywin32/PyIInitializeWithFile__Initialize_meth.html

Passes a file path to a property handler on startup. The method accepts a full file path and a mode indicating whether properties can be written (STGM_READ or STGM_READWRITE).

```APIDOC
## PyIInitializeWithFile.Initialize

### Description
Passes a file path to a property handler on startup.

### Method
Initialize

### Signature
Initialize(_FilePath_, _Mode_)

### Parameters
- **FilePath** (str) - Required - Full path to the file whose properties are to be accessed.
- **Mode** (int) - Required - Indicates if properties can be written, STGM_READ or STGM_READWRITE.

```

--------------------------------

### GetCLSID

Source: https://mhammond.github.io/pywin32/PyIShellItem2.html

Retrieves the value of a property as a GUID.

```APIDOC
## GetCLSID

### Description
Retrieves the value of a property as a GUID.

### Method
GetCLSID

### Parameters
None

### Return Value
The value of the property as a GUID.
```

--------------------------------

### Initialize(_guid_)

Source: https://mhammond.github.io/pywin32/PyIDirectSound__Initialize_meth.html

Binds the DirectSound object to the specified sound driver. Pass None to select the primary sound driver.

```APIDOC
## Initialize(_guid_)

### Description
Binds the DirectSound object to the specified sound driver.

### Method
Initialize

### Parameters
- **_guid_** (PyIID) - Required - Globally unique identifier (GUID) specifying the sound driver to which this DirectSound object binds. Pass None to select the primary sound driver.

### Return Value
No return value is documented.
```

--------------------------------

### SetClass

Source: https://mhammond.github.io/pywin32/PyIPropertyStorage.html

Sets the GUID for the property set.

```APIDOC
## SetClass

### Description
Sets the GUID for the property set.

### Method
SetClass

### Parameters
None documented.

### Response
No return value documented.
```

--------------------------------

### Initialize a Dialog instance

Source: https://mhammond.github.io/pywin32/html/pythonwin/doc/architecture.html

Demonstrates importing the necessary modules and creating an instance of a Dialog class.

```python
>>> import win32ui # import the base win32ui module.   
 >>> import dialog # import dialog.py  
 >>> d=dialog.Dialog(win32ui.IDD_SIMPLE_INPUT)  
 >>> d  
 <Dialog instance at 886c78>
```

--------------------------------

### GetDC

Source: https://mhammond.github.io/pywin32/win32gui.html

Gets the device context for the window.

```APIDOC
## GetDC

### Description
Gets the device context for the window.

### Method
N/A (SDK function)

### Parameters
Not specified in source.

### Returns
Not specified in source.
```

--------------------------------

### GetMenu

Source: https://mhammond.github.io/pywin32/win32gui.html

Gets the menu for the specified window.

```APIDOC
## GetMenu

### Description
Gets the menu for the specified window.

### Method
N/A (SDK function)

### Parameters
Not specified in source.

### Returns
Not specified in source.
```

--------------------------------

### win32service.StartService

Source: https://mhammond.github.io/pywin32/win32service__StartService_meth.html

Starts the specified service. The function requires a handle to the service and a list of arguments to pass to the service.

```APIDOC
## win32service.StartService

### Description
Starts the specified service.

### Method
StartService

### Parameters
#### hService
- **type**: PySC_HANDLE - Required - Handle to the service to be started

#### args
- **type**: [string, ...] - Required - Arguments to the service.

### Return Value
No return value is documented.
```

--------------------------------

### split_path

Source: https://mhammond.github.io/pywin32/isapi.install.html

Gets the parent path and basename.

```APIDOC
## split_path

### Description
Gets the parent path and basename.

### Method
Function

### Parameters
- **path** (string) - Required - The path to split.

### Returns
Tuple containing parent path and basename.
```

--------------------------------

### PyCWnd.BeginPaint

Source: https://mhammond.github.io/pywin32/PyCWnd__BeginPaint_meth.html

Prepares a window for painting. Returns a PyCDC object and a PAINTSTRUCT. Must be paired with PyCWnd::EndPaint.

```APIDOC
## PyCWnd.BeginPaint

### Description
Prepares a window for painting. Returns a device context (PyCDC) and a PAINTSTRUCT. Must be paired with PyCWnd::EndPaint.

### Method
BeginPaint

### Signature
PyCDC, PAINTSTRUCT = BeginPaint()

### Parameters
None

### Return Value
- **PyCDC** - The device context for painting.
- **PAINTSTRUCT** - The paint structure containing painting information.

### Remarks
Call this method before painting and call PyCWnd::EndPaint after painting is complete.
```

--------------------------------

### PyIExplorerBrowser.Initialize

Source: https://mhammond.github.io/pywin32/PyIExplorerBrowser__Initialize_meth.html

Initializes the Explorer Browser with the specified parent window, rectangle, and folder settings.

```APIDOC
## PyIExplorerBrowser.Initialize

### Description
Initializes the Explorer Browser with the specified parent window, rectangle, and folder settings.

### Method
Initialize

### Parameters
- **hwndParent** (HWND) - Description for hwndParent
- **prc** (PyRECT) - Description for prc
- **pfs** (PyFOLDERSETTINGS) - Description for pfs

### Return Value
No return value is documented.
```

--------------------------------

### GetCount

Source: https://mhammond.github.io/pywin32/PyIPropertyDescriptionList.html

Gets the number of properties in the list.

```APIDOC
## GetCount

### Description
Gets the number of properties in the list.

### Method
GetCount

### Parameters
None

### Returns
Number of properties in the list.
```

--------------------------------

### GetTypeInfo

Source: https://mhammond.github.io/pywin32/PyIDispatch.html

Gets type information for the object.

```APIDOC
## GetTypeInfo

### Description
Get type information for the object.

### Method
GetTypeInfo

### Parameters
- **LCID** - The locale identifier.

### Returns
- A PyITypeInfo object containing type information.
```
Tokens:
Raw