### InstallModule Source: https://mhammond.github.io/pywin32/isapi.install.html Install the extension. ```APIDOC ## InstallModule ### Description Install the extension. ### Method Not specified (likely a function call within a Python module) ### Endpoint Not applicable (Python module function) ### Parameters Not specified in the source text. ### Request Example Not applicable. ### Response Not specified in the source text. ``` -------------------------------- ### Start Source: https://mhammond.github.io/pywin32/PyIInternetProtocolRoot.html Initiates or starts an operation within the PyIInternetProtocolRoot interface. ```APIDOC ## Start ### Description Description of Start ### Method (Not specified in source) ### Endpoint (Not specified in source) ### Parameters (Not specified in source) ### Request Example (Not specified in source) ### Response (Not specified in source) ``` -------------------------------- ### StartService Source: https://mhammond.github.io/pywin32/win32service.html Starts the specified service. ```APIDOC ## StartService ### Description Starts the specified service. ### Method Not specified (likely a function call in a Python SDK) ### Endpoint Not applicable (SDK function) ### Parameters Not specified in source. ### Request Example Not specified in source. ### Response Not specified in source. ``` -------------------------------- ### 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 Not specified (likely a method call on the PyCWinThread object) ### Parameters None explicitly documented. ### Response None explicitly documented. ``` -------------------------------- ### Play Source: https://mhammond.github.io/pywin32/PyIDirectSoundCaptureBuffer.html Starts the sound capture buffer. ```APIDOC ## Play ### Description Starts the sound capture buffer. ### Method Not specified, but likely a method call on the PyIDirectSoundCaptureBuffer object. ### Parameters Not specified in the source text. ### Request Example ``` # Example usage (syntax may vary) buffer.Play() ``` ### Response Not specified in the source text. ``` -------------------------------- ### HandleCommandLine Source: https://mhammond.github.io/pywin32/isapi.install__HandleCommandLine_meth.html Perform installation or removal of an ISAPI filter or extension. ```APIDOC ## HandleCommandLine ### Description Perform installation or removal of an ISAPI filter or extension. ### Method Not specified (likely a Python function call) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Parameters - **_params_** (object) - Required - Configuration information. - **argv** (list, optional) - Command-line arguments. - **conf_module_name** (string, optional) - Name of the configuration module. - **default_arg** (string, optional) - Default argument for installation. - **opt_parser** (object, optional) - Option parser object. - **custom_arg_handlers** (dict, optional) - Custom argument handlers. ``` -------------------------------- ### StartDoc Source: https://mhammond.github.io/pywin32/PyCDC.html Starts spooling a document to a printer device context. ```APIDOC ## StartDoc ### Description Starts spooling a document to a printer DC. ### Method Not specified (assumed to be a method call on a PyCDC object) ### Parameters (Specific parameters not detailed in the source text) ### Request Example ```python # Example usage (assuming 'dc' is a PyCDC object) # dc.StartDoc("My Document") ``` ### Response (Specific response details not detailed in the source text) ``` -------------------------------- ### StartPage Source: https://mhammond.github.io/pywin32/PyCDC.html Starts a new page on a printer device context. ```APIDOC ## StartPage ### Description Starts a new page on a printer DC. ### Method Not specified (assumed to be a method call on a PyCDC object) ### Parameters None specified. ### Request Example ```python # Example usage (assuming 'dc' is a PyCDC object) # dc.StartPage() ``` ### Response (Specific response details not detailed in the source text) ``` -------------------------------- ### GetSelection Source: https://mhammond.github.io/pywin32/PyCSliderCtrl__GetSelection_meth.html Gets the control's selection start and end positions. ```APIDOC ## GetSelection ### Description Retrieves the start and end positions of the current selection in a CSliderCtrl. ### Method None (This is a method call on an object, not an HTTP endpoint) ### Parameters None ### Returns - **int**: The start and end positions of the selection. The exact format of the returned integer may depend on the underlying C++ implementation, but it typically encodes both values. ``` -------------------------------- ### PyIShellExtInit.Initialize Source: https://mhammond.github.io/pywin32/PyIShellExtInit__Initialize_meth.html Initializes the shell extension with context information. ```APIDOC ## Initialize ### Description Initializes the shell extension with context information, including the folder, data object, and registry key. ### Method Initialize ### Parameters #### Path Parameters - **_pFolder_** (PyIDL) - Description for pFolder - **pDataObject_** (PyIDataObject) - Description for pDataObject - **hkey_** (PyHANDLE) - Description for hkey ``` -------------------------------- ### 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 (Not specified in source) ### Endpoint (Not specified in source) ### Parameters (Not specified in source) ### Request Example (Not specified in source) ### Response #### Success Response (200) (Not specified in source) #### Response Example (Not specified in source) ``` -------------------------------- ### Instantiate and Use a COM Object Source: https://mhammond.github.io/pywin32/html/com/win32com/HTML/QuickStartClientCom.html Demonstrates the basic steps to instantiate a COM object by its ProgID, call its methods, and set/get its properties. ```python import win32com.client o = win32com.client.Dispatch("Object.Name") o.Method() o.property = "New Value" print(o.property) ``` -------------------------------- ### Get and Modify User Information in Exchange Source: https://mhammond.github.io/pywin32/html/com/help/adsi.html This example demonstrates how to retrieve and update user attributes in Exchange. It uses `Getinfo()` to load user data, `Get()` to access specific attributes, and `Put()` followed by `Setinfo()` to modify them. ```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() ``` -------------------------------- ### Initialize Source: https://mhammond.github.io/pywin32/PyIDirectSoundCaptureBuffer.html Initializes the sound capture buffer. ```APIDOC ## Initialize ### Description Initializes the sound capture buffer. ### Method Not specified, but likely a method call on the PyIDirectSoundCaptureBuffer object. ### Parameters Not specified in the source text. ### Request Example ``` # Example usage (syntax may vary) buffer.Initialize() ``` ### Response Not specified in the source text. ``` -------------------------------- ### GetWindowOrg Method Example Source: https://mhammond.github.io/pywin32/PyCDC__GetWindowOrg_meth.html Retrieves the x- and y-coordinates of the window's origin. No setup or imports are required beyond having a valid device context. ```python x, y = GetWindowOrg() ``` -------------------------------- ### GetDeferredText Source: https://mhammond.github.io/pywin32/PyIDebugDocumentHost__GetDeferredText_meth.html Retrieves deferred text from the document host. This method is used to get a portion of text starting from a specified cookie, up to a maximum number of characters. ```APIDOC ## GetDeferredText ### Description Retrieves deferred text from the document host. This method is used to get a portion of text starting from a specified cookie, up to a maximum number of characters. ### Method GetDeferredText ### Parameters #### Path Parameters - **_dwTextStartCookie_** (int) - Description for dwTextStartCookie - **cMaxChars_** (int) - Description for cMaxChars ``` -------------------------------- ### PrepareToHostSingle Source: https://mhammond.github.io/pywin32/servicemanager__PrepareToHostSingle_meth.html Prepares to host a single service in this EXE. The _klass_ parameter specifies the Python class to host. If not provided, the service name is retrieved from the registry, and the specified class is instantiated. ```APIDOC ## PrepareToHostSingle ### Description Prepares to host a single service in this EXE. ### Method (Not specified, likely a Python method call) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Parameters _klass=None_: - **_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. ``` -------------------------------- ### win32file.SetupComm Source: https://mhammond.github.io/pywin32/win32file__SetupComm_meth.html Initializes the communications parameters for a specified communications device. ```APIDOC ## win32file.SetupComm ### Description Initializes the communications parameters for a specified communications device. ### Parameters * **_handle_** (PyHANDLE) - The handle to the communications device. * **dwInQueue** (int) - Specifies the recommended size, in bytes, of the device's internal input buffer. * **dwOutQueue** (int) - Specifies the recommended size, in bytes, of the device's internal output buffer. ``` -------------------------------- ### Get Mountain Standard Time Zone Info Source: https://mhammond.github.io/pywin32/win32timezone.TimeZoneInfo.html Instantiate a TimeZoneInfo object for 'Mountain Standard Time'. This is a basic example of retrieving a specific time zone. ```python >>> MST = TimeZoneInfo('Mountain Standard Time') ``` -------------------------------- ### Split Path Examples Source: https://mhammond.github.io/pywin32/isapi.install__split_path_meth.html Demonstrates the behavior of split_path with different path inputs, including root, empty, and relative paths. ```python >>> split_path('/') ['', ''] ``` ```python >>> split_path('') ['', ''] ``` ```python >>> split_path('foo') ['', 'foo'] ``` ```python >>> split_path('/foo') ['', 'foo'] ``` ```python >>> split_path('/foo/bar') ['/foo', 'bar'] ``` ```python >>> split_path('foo/bar') ['/foo', 'bar'] ``` -------------------------------- ### Resolve MUI Time Zone Name Source: https://mhammond.github.io/pywin32/win32timezone__resolveMUITimeZone_meth.html Demonstrates how to use resolveMUITimeZone to get a time zone name from a MUI resource. The specifier '@tzres.dll,-110' is used as an example. ```python >>> import sys >>> result = resolveMUITimeZone('@tzres.dll,-110') >>> type(result) is str True ``` -------------------------------- ### GetPRINTDLGMinPage Source: https://mhammond.github.io/pywin32/PyCPrintInfo__GetPRINTDLGMinPage_meth.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 None (This is a method call on an object) ### Endpoint None (This is an SDK method) ### Parameters None ### Response #### Success Response Returns the minimum page number (integer). #### Response Example None provided in source. ``` -------------------------------- ### LocateWebServerPath Example 2 Source: https://mhammond.github.io/pywin32/isapi.install__LocateWebServerPath_meth.html Demonstrates searching for a web server using the 'Default Web Site' name. ```Python >>> LocateWebServerPath('Default Web Site') # doctest: +SKIP ``` -------------------------------- ### C++: Get Process Instances with Manual Management Source: https://mhammond.github.io/pywin32/html/win32/help/process_info.html A C++ implementation to retrieve process instances using PdhEnumObjectItems. This example requires manual memory allocation for buffers and careful parsing of NULL-terminated strings. ```cpp HRESULT getinst (map < string,int > & m_inst) { map::iterator iter; USES_CONVERSION; LPTSTR szCountersBuf = NULL; DWORD dwCountersSize = 0; LPTSTR szInstancesBuf = NULL; DWORD dwInstancesSize = 0; LPTSTR szTemp = NULL; PDH_STATUS status; std::string str_obj="Process"; status = PdhEnumObjectItems( NULL, NULL, A2CT(str_obj.c_str()), NULL, &dwCountersSize, szInstancesBuf, &dwInstancesSize, PERF_DETAIL_WIZARD, 0 ); if ( ERROR_SUCCESS != status ) return E_FAIL; if (dwCountersSize) { szCountersBuf = (LPTSTR)malloc (dwCountersSize * sizeof (TCHAR)); if (szCountersBuf==NULL) { return E_FAIL; } } else szCountersBuf=NULL; if (dwInstancesSize) { szInstancesBuf = (LPTSTR)malloc (dwInstancesSize * sizeof (TCHAR)); if (szInstancesBuf==NULL) { free(szCountersBuf); return E_FAIL; } } else szInstancesBuf = NULL; status = PdhEnumObjectItems( NULL, NULL, A2CT(str_obj.c_str()), szCountersBuf, &dwCountersSize, szInstancesBuf, &dwInstancesSize, PERF_DETAIL_WIZARD, 0 ); if ( ERROR_SUCCESS != status ) return E_FAIL; // it's a series of contiguous NULL terminated strings, ending w/zero length string if (szInstancesBuf){ for (szTemp = szInstancesBuf;*szTemp != 0;szTemp += lstrlen(szTemp) + 1) { m_inst[T2A(szTemp)]++; //increment instance counter //default value is zero for arith element } } return S_OK; } ``` -------------------------------- ### Start Source: https://mhammond.github.io/pywin32/PyIDebugExpression.html Starts the evaluation of the debug expression. ```APIDOC ## Start ### Description Starts the evaluation of the debug expression. ### Method (Not specified, assumed to be a method call on the object) ### Parameters (No parameters specified) ### Response (No response details specified) ``` -------------------------------- ### PrepareToHostSingle Source: https://mhammond.github.io/pywin32/servicemanager.html Prepares the service manager to host a single service. ```APIDOC ## PrepareToHostSingle ### Description Prepares the service manager to host a single service. ### Method (Not specified in source) ### Endpoint (Not specified in source) ### Parameters (Not specified in source) ### Request Example (Not specified in source) ### Response #### Success Response (200) (Not specified in source) #### Response Example (Not specified in source) ``` -------------------------------- ### STARTUPINFO Source: https://mhammond.github.io/pywin32/win32process.html Creates a new STARTUPINFO object. ```APIDOC ## STARTUPINFO ### Description Creates a new STARTUPINFO object. ### Method Not applicable (constructor-like function) ### Endpoint Not applicable ### Parameters None explicitly documented in this snippet. ### Request Example None provided. ### Response None provided. ``` -------------------------------- ### New Source: https://mhammond.github.io/pywin32/pythoncom.html Create a new instance of an OLE automation server. ```APIDOC ## New ### Description Create a new instance of an OLE automation server. ### Method (Not specified, likely a Python method call) ### Endpoint (Not applicable) ### Parameters (None specified) ### Request Example (Not applicable) ### Response (Not specified) ``` -------------------------------- ### Create COM Record from GUIDs (Late-bound) Source: https://mhammond.github.io/pywin32/html/com/win32com/HTML/COM_Records.html Use `pythoncom.GetRecordFromGuids` to create a COM Record instance when makepy-support is unavailable. Requires the Type Library GUID, major and minor versions, LCID, and the COM Record's GUID. ```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) ``` -------------------------------- ### LocateWebServerPath Example 1 Source: https://mhammond.github.io/pywin32/isapi.install__LocateWebServerPath_meth.html Demonstrates searching for a web server using a numeric description. ```Python >>> LocateWebServerPath('1') #doctest: +SKIP ``` -------------------------------- ### GetDefaultSearchGUID Source: https://mhammond.github.io/pywin32/PyIShellFolder2__GetDefaultSearchGUID_meth.html Retrieves the default search GUID for the folder. The _pguid_ parameter is an output parameter that will receive the GUID. ```APIDOC ## GetDefaultSearchGUID ### Description Retrieves the default search for the folder. ### Parameters #### Output Parameters - **_pguid_** (PyIID) - Description for pguid ``` -------------------------------- ### SetGuid Source: https://mhammond.github.io/pywin32/PyICreateTypeLib2__SetGuid_meth.html Sets a GUID for the type library. This method takes a GUID as input and associates it with the type library. ```APIDOC ## PyICreateTypeLib2::SetGuid ### Description Sets a GUID for the type library. ### Method ``` SetGuid(_guid_) ``` ### Parameters #### _guid_ - **_guid_** (PyIID) - Required - Description for guid ``` -------------------------------- ### PrepareToHostMultiple Source: https://mhammond.github.io/pywin32/servicemanager__PrepareToHostMultiple_meth.html Prepares the current executable to host multiple services. This is useful when you need to run several distinct services from a single Python process. ```APIDOC ## PrepareToHostMultiple ### Description Prepares the current executable to host multiple services. This is useful when you need to run several distinct services from a single Python process. ### Method (Not specified, likely a Python method call) ### Parameters #### Path Parameters (None) #### Query Parameters (None) #### Request Body (None) ### Parameters * **_service_name_** (string) - Required - The name of the service hosted by the class. * **klass_** (object) - Required - The Python class to host. ``` -------------------------------- ### PyCComboBox.SetEditSel Source: https://mhammond.github.io/pywin32/PyCComboBox__SetEditSel_meth.html Sets the selection in the edit control portion of a combo box. The start and end parameters define the selection range. If start is -1, any existing selection is removed. If end is -1, all text from start to the end of the control is selected. ```APIDOC ## PyCComboBox.SetEditSel ### Description Sets the selection in the edit control portion of a combo box. ### Parameters #### Path Parameters - **_start_** (int) - Required - Specifies the starting position. If the starting position is set to -1, then any existing selection is removed. - **end_** (int) - Required - Specifies the ending position. If the ending position is set to -1, then all text from the starting position to the last character in the edit control is selected. ### Return Value The return value is always None. An exception is raised if the combo is a dropdown style, or does not have an edit control. ``` -------------------------------- ### Initialize Source: https://mhammond.github.io/pywin32/PyIDirectSoundCapture.html Description of Initialize. ```APIDOC ## Initialize ### Description Description of Initialize. ### Method [Method signature or HTTP method if applicable] ### Parameters [Parameters if applicable] ### Response [Response details if applicable] ``` -------------------------------- ### PyICreateTypeInfo.SetGuid Source: https://mhammond.github.io/pywin32/PyICreateTypeInfo__SetGuid_meth.html The SetGuid method sets the GUID for the type information. It takes a single parameter, _guid_, which is the PyIID representing the GUID. ```APIDOC ## PyICreateTypeInfo.SetGuid ### Description Sets the GUID for the type information. ### Method Invoke (Implicit) ### Parameters #### Path Parameters - **_guid_** (PyIID) - Required - Description for guid ``` -------------------------------- ### PrepareToHostMultiple Source: https://mhammond.github.io/pywin32/servicemanager.html Prepares the service manager to host multiple services. ```APIDOC ## PrepareToHostMultiple ### Description Prepares the service manager to host multiple services. ### Method (Not specified in source) ### Endpoint (Not specified in source) ### Parameters (Not specified in source) ### Request Example (Not specified in source) ### Response #### Success Response (200) (Not specified in source) #### Response Example (Not specified in source) ``` -------------------------------- ### 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 Not specified (likely a function call in a Python SDK) ### Endpoint Not applicable (SDK function) ### Parameters Not specified in source. ### Request Example Not specified in source. ### Response Not specified in source. ``` -------------------------------- ### Get Global Memory Status Source: https://mhammond.github.io/pywin32/win32api__GlobalMemoryStatusEx_meth.html Call GlobalMemoryStatusEx to get a dictionary containing physical and virtual memory usage statistics. ```python dict = GlobalMemoryStatusEx() ``` -------------------------------- ### 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 Not specified (likely a constructor or initialization method) ### Parameters None explicitly documented. ### Response None explicitly documented. ``` -------------------------------- ### Create TimeZoneInfo Object and Get Current Time Source: https://mhammond.github.io/pywin32/win32timezone.html Creates a TimeZoneInfo object for 'Mountain Standard Time' and gets the current datetime with this time zone. ```python MST = win32timezone.TimeZoneInfo('Mountain Standard Time') now = datetime.datetime.now(MST) ``` -------------------------------- ### Get Timezone Name for Specific Dates Source: https://mhammond.github.io/pywin32/win32timezone.TimeZoneInfo__tzname_meth.html Demonstrates how to get the timezone name for different dates, showing the difference between standard and daylight saving times. ```python MST = TimeZoneInfo('Mountain Standard Time') MST.tzname(datetime.datetime(2003, 8, 2)) ``` ```python MST.tzname(datetime.datetime(2003, 11, 25)) ``` ```python MST.tzname(None) ``` -------------------------------- ### FindText Method Source: https://mhammond.github.io/pywin32/PyCRichEditCtrl__FindText_meth.html Finds text within the Rich Edit control starting from a given character position. It returns the start and end character positions of the found text. ```APIDOC ## FindText ### Description Finds text in the control. ### Method Signature `int, (start, end) = FindText(_charPos_)` ### Parameters #### _charPos_ - **_charPos_** (int) - The character position from where to start the search. ### Returns - **start** (int) - The starting character position of the found text. - **end** (int) - The ending character position of the found text. ``` -------------------------------- ### Initialize HTML Help System Source: https://mhammond.github.io/pywin32/win32help__HtmlHelp_meth.html Initializes the HTML Help system. This must be the first command called and returns a cookie for uninitialization. It configures HTML Help to run on the same thread as the calling application. ```python hwnd = win32help.HtmlHelp(0, None, win32help.HH_INITIALIZE, 0) ``` -------------------------------- ### GetResource Source: https://mhammond.github.io/pywin32/win32ui.html Gets a resource. ```APIDOC ## GetResource ### Description Gets a resource. ### Method Not specified (likely a method call on a win32ui object) ### Endpoint Not applicable (SDK method) ### Parameters None explicitly documented. ### Response Returns a resource. ``` -------------------------------- ### CreateDesktop Source: https://mhammond.github.io/pywin32/win32service__CreateDesktop_meth.html Creates a new desktop in the calling process's current window station. It takes the desktop name, flags, desired access, and security attributes as parameters. ```APIDOC ## CreateDesktop ### Description Creates a new desktop in the calling process's current window station. ### Method win32service.CreateDesktop ### Parameters #### Path Parameters - **_Desktop_** (string) - Name of desktop to create - **Flags_** (int) - DF_ALLOWOTHERACCOUNTHOOK or 0 - **DesiredAccess_** (int) - An ACCESS_MASK determining level of access available thru returned handle - **SecurityAttributes_** (PySECURITY_ATTRIBUTES) - Specifies inheritance and controls access to desktop ``` -------------------------------- ### win32service.StartService Source: https://mhammond.github.io/pywin32/win32service__StartService_meth.html Starts the specified service. This method takes a service handle and an optional list of arguments to pass to the service upon startup. ```APIDOC ## StartService _hService_ , _args_ ### Description Starts the specified service. ### Parameters * __hService__ (PySC_HANDLE) - Required - Handle to the service to be started. * __args__ (list of strings) - Optional - Arguments to the service. ``` -------------------------------- ### PyIInitializeWithFile.Initialize Source: https://mhammond.github.io/pywin32/PyIInitializeWithFile__Initialize_meth.html Initializes the property handler with a file path and access mode. ```APIDOC ## Initialize ### Description Passes a file path to a property handler on startup. ### Method Initialize ### Parameters #### Path 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. ``` -------------------------------- ### Get Current UTC Time Source: https://mhammond.github.io/pywin32/win32timezone__utcnow_meth.html Call `utcnow()` to get the current UTC time. Verify it is within 5 seconds of the system's current UTC time and that its timezone info is of type `TimeZoneInfo`. ```python >>> now = utcnow() >>> (now - datetime.datetime.now(datetime.timezone.utc)) < datetime.timedelta(seconds = 5) True >>> type(now.tzinfo) is TimeZoneInfo True ``` -------------------------------- ### Initialize Source: https://mhammond.github.io/pywin32/servicemanager.html Initializes the service manager. ```APIDOC ## Initialize ### Description Initializes the service manager. ### Method (Not specified in source) ### Endpoint (Not specified in source) ### Parameters (Not specified in source) ### Request Example (Not specified in source) ### Response #### Success Response (200) (Not specified in source) #### Response Example (Not specified in source) ``` -------------------------------- ### axdebug.DOCUMENTNAMETYPE_URL Source: https://mhammond.github.io/pywin32/axdebug_DOCUMENTNAMETYPE_URL.html Gets the URL of the document, if any. ```APIDOC ## axdebug.DOCUMENTNAMETYPE_URL ### Description Gets the URL of the document, if any. ### Method Not applicable (constant/variable) ### Endpoint Not applicable (constant/variable) ### Parameters None ### Request Example None ### Response #### Success Response - **URL** (string) - The URL of the document, or an empty string if none exists. ``` -------------------------------- ### InstallCallbackCaller Source: https://mhammond.github.io/pywin32/win32ui.html Installs a callback caller. ```APIDOC ## InstallCallbackCaller ### Description Installs a callback caller. ### Method Not specified (likely a function call) ### Endpoint Not applicable (SDK method) ### Parameters None explicitly documented. ### Response None explicitly documented. ``` -------------------------------- ### Advise Source: https://mhammond.github.io/pywin32/PyIConnectionPoint__Advise_meth.html Establishes a connection between the connection point object and the client's sink. ```APIDOC ## Advise ### Description Establishes a connection between the connection point object and the client's sink. ### Method PyIConnectionPoint.Advise ### Parameters #### Path Parameters - **_unk_** (PyIUnknown) - Required - The client's advise sink ### Return Value - **connection_point_identifier** (int) - The connection point identifier used by PyIConnectionPoint::Unadvise ``` -------------------------------- ### Arc(_rect_, pointStart, pointEnd) Source: https://mhammond.github.io/pywin32/PyCDC__Arc_meth.html Draws an elliptical arc within a specified bounding rectangle. The arc starts and ends at points determined by rays from the ellipse's center through the provided start and end points. ```APIDOC ## Arc(_rect_, pointStart, pointEnd) ### Description Draws an elliptical arc. The arc is a segment of the ellipse defined by the specified bounding rectangle. The actual starting point is where a ray from the center through `pointStart` intersects the ellipse, and similarly for the `pointEnd`. The arc is drawn counterclockwise. ### Parameters * **_rect_** (tuple: left, top, right, bottom) - Required - Specifies the ellipse's bounding rectangle. Both width and height must be greater than 2 and less than 32,767 units. * **pointStart** (tuple: x, y) - Required - Specifies the x- and y-coordinates of the point that defines the arc's starting point (in logical units). This point does not have to lie exactly on the arc. * **pointEnd** (tuple: x, y) - Required - Specifies the x- and y-coordinates of the point that defines the arc's ending point (in logical units). This point does not have to lie exactly on the arc. ### Return Value Always none. If the function fails, an exception is raised. ``` -------------------------------- ### 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 ## Init(_flags_, assoc, hkeyProgId=None, hwnd=None) ### Description Initializes the IQueryAssociations interface and sets the root key to the appropriate ProgID. ### Parameters #### 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 ``` -------------------------------- ### CreateWindowStation Source: https://mhammond.github.io/pywin32/win32service.html Creates a new window station. ```APIDOC ## CreateWindowStation ### Description Creates a new window station. ### Method Not specified (likely a function call in a Python SDK) ### Endpoint Not applicable (SDK function) ### Parameters Not specified in source. ### Request Example Not specified in source. ### Response Not specified in source. ``` -------------------------------- ### StartDebuggerPump Source: https://mhammond.github.io/pywin32/win32ui.html Starts the debugger message pump. ```APIDOC ## StartDebuggerPump ### Description Starts the debugger message pump. ### Method Not specified (likely a function call) ### Endpoint Not applicable (SDK method) ### Parameters None explicitly documented. ### Response None explicitly documented. ``` -------------------------------- ### win32process.GetStartupInfo Source: https://mhammond.github.io/pywin32/win32process__GetStartupInfo_meth.html Retrieves the STARTUPINFO structure associated with the calling process. ```APIDOC ## win32process.GetStartupInfo ### Description Retrieves the contents of the STARTUPINFO structure that was specified when the calling process was created. ### Method None (This is a Python method call, not an HTTP request) ### Endpoint win32process.GetStartupInfo() ### Parameters This method does not take any parameters. ### Response #### Success Response Returns a STARTUPINFO structure object containing process startup information. ``` -------------------------------- ### Initialize win32ui in InitInstance Source: https://mhammond.github.io/pywin32/html/pythonwin/doc/EmbeddingWin32ui.html Call DynamicApplicationInit within your CWinApp::InitInstance method to initialize the win32ui extension. This example assumes a Python script 'initscore' is used for initialization. ```C++ 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; } ... ``` -------------------------------- ### GetTransactionId Source: https://mhammond.github.io/pywin32/win32transaction__GetTransactionId_meth.html Returns the transaction's GUID. ```APIDOC ## GetTransactionId _TransactionHandle_ ### Description Returns the transaction's GUID. ### Parameters #### Path Parameters * **_TransactionHandle_** (PyHANDLE) - Required - Handle to a transaction ``` -------------------------------- ### 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 Not specified (assumed to be a method call on a PyIShellItem2 object) ### Endpoint Not applicable (SDK method) ### Parameters None explicitly specified. ``` -------------------------------- ### SetClass Source: https://mhammond.github.io/pywin32/PyIPropertyStorage__SetClass_meth.html Sets the GUID for the property set. ```APIDOC ## SetClass ### Description Sets the GUID for the property set. ### Parameters #### Path Parameters - **_clsid_** (PyIID) - Required - Description for clsid ``` -------------------------------- ### GetMenuInfo Source: https://mhammond.github.io/pywin32/win32gui.html Gets information about a specified menu. ```APIDOC ## GetMenuInfo ### Description Gets information about a specified menu. ### Method (Not specified in source, likely a function call) ### Endpoint (Not applicable, SDK function) ### Parameters (Not specified in source) ### Request Example (Not applicable, SDK function) ### Response (Not specified in source) ``` -------------------------------- ### PSGetPropertyDescription Source: https://mhammond.github.io/pywin32/propsys.html Gets a description interface for a property. ```APIDOC ## PSGetPropertyDescription ### Description Gets a description interface for a property. ### Method Not specified (likely a function call within the Python module) ### Endpoint Not applicable (Python module function) ### Parameters Not specified in the source text. ### Request Example Not specified in the source text. ### Response Not specified in the source text. ``` -------------------------------- ### Create Source: https://mhammond.github.io/pywin32/PyDDEServer.html Creates a DDE server instance. ```APIDOC ## Create ### Description Creates a DDE server. ### Method Not specified (assumed to be a static method or constructor) ### Parameters (No specific parameters documented in the source) ### Request Example (No request example provided in the source) ### Response (No specific response documented in the source) ``` -------------------------------- ### split_path Source: https://mhammond.github.io/pywin32/isapi.install.html Get the parent path and basename. ```APIDOC ## split_path ### Description Get the parent path and basename. ### Method Not specified (likely a function call within a Python module) ### Endpoint Not applicable (Python module function) ### Parameters Not specified in the source text. ### Request Example Not applicable. ### Response Not specified in the source text. ``` -------------------------------- ### Initialize Source: https://mhammond.github.io/pywin32/servicemanager__Initialize_meth.html Initializes the module for hosting a service. This is generally called automatically. ```APIDOC ## Initialize ### Description Initializes the module for hosting a service. This is generally called automatically. ### Method Initialize ### Parameters #### Path Parameters - **_eventSourceName_** (string) - Optional - The event source name - **_eventSourceFile_** (string) - Optional - The name of the file (generally a DLL) with the event source messages. ``` -------------------------------- ### InstallModule Source: https://mhammond.github.io/pywin32/isapi.install__InstallModule_meth.html Installs an extension module. It takes the module name, parameters, options, and a log function as arguments. ```APIDOC ## InstallModule ### Description Installs the extension module. ### Method InstallModule ### Parameters #### Path Parameters - **_conf_module_name_** (string) - Required - The name of the configuration module to install. - **params_ _** (any) - Optional - Parameters for the installation. - **options_ _** (any) - Optional - Options for the installation. - **log=function lambda at 0x000001FFE1CB2550_** (function) - Optional - A log function for recording installation progress. ``` -------------------------------- ### GetTypeInfo Source: https://mhammond.github.io/pywin32/PyIDispatch.html Get type information for the object. ```APIDOC ## GetTypeInfo ### Description Get type information for the object. ### Method (Not specified, likely a method call on the PyIDispatch object) ### Parameters (Not specified in source) ### Request Example (Not specified in source) ### Response (Not specified in source) ``` -------------------------------- ### HandleCommandLine Source: https://mhammond.github.io/pywin32/isapi.install.html Perform installation or removal of an ISAPI filter or extension based on command line arguments. ```APIDOC ## HandleCommandLine ### Description Perform installation or removal of an ISAPI filter or extension based on command line arguments. ### Method Not specified (likely a function call within a Python module) ### Endpoint Not applicable (Python module function) ### Parameters Not specified in the source text. ### Request Example Not applicable. ### Response Not specified in the source text. ``` -------------------------------- ### GetIDsOfNames Source: https://mhammond.github.io/pywin32/PyIDispatch.html Get the DISPID for the passed names. ```APIDOC ## GetIDsOfNames ### Description Get the DISPID for the passed names. ### Method (Not specified, likely a method call on the PyIDispatch object) ### Parameters (Not specified in source) ### Request Example (Not specified in source) ### Response (Not specified in source) ``` -------------------------------- ### GetSize Source: https://mhammond.github.io/pywin32/PyIDebugDocumentText.html Gets the size of the debug document. ```APIDOC ## GetSize ### Description Gets the size of the debug document. ### Method Not specified (assumed to be a method call on the PyIDebugDocumentText object) ### Parameters None explicitly mentioned. ### Response The size of the document. Specific type not detailed. ``` -------------------------------- ### HH_INITIALIZE Source: https://mhammond.github.io/pywin32/win32help__HtmlHelp_meth.html Initializes the help system. This command must be called first and returns a cookie for HH_UNINITIALIZE. It configures HTML Help to run on the same thread as the calling application. ```APIDOC ## HH_INITIALIZE ### Description Initializes the help system for use. This command must be the first HTML Help command called. It returns a cookie that must be used in the HH_UNINITIALIZE call. HH_INITIALIZE configures HTML Help to run on the same thread as the calling application instead of a secondary thread by setting the global property HH_GPROPID_SINGLETHREAD to VARIANT_TRUE. Running HTML Help on the same thread as the calling application requires the calling application to send messages to HTML Help by calling the HH_PRETRANSLATEMESSAGE command. ### Parameters #### Request Body - **file** (None) - Required - Must be None. - **data** (Ignored) - Ignored. ``` -------------------------------- ### GetTicArray Source: https://mhammond.github.io/pywin32/PyCSliderCtrl.html Get the array of tic positions. ```APIDOC ## GetTicArray ### Description Retrieves an array containing the positions of all tic marks in the slider control. ### Method (Not specified, likely a getter method) ### Endpoint (Not applicable for SDK methods) ### Parameters (No parameters specified in the source) ### Request Example (Not applicable) ### Response #### Success Response - **tic_positions** (array of int) - An array where each element is the position of a tic mark. ``` -------------------------------- ### Init Source: https://mhammond.github.io/pywin32/PyIDebugDocumentHelper.html Initializes the PyIDebugDocumentHelper object. ```APIDOC ## Init ### Description Description of Init ### Method (Not specified, assumed to be part of object initialization) ### Endpoint (Not applicable for SDK methods) ### Parameters (Not specified) ### Request Example (Not applicable) ### Response (Not specified) ``` -------------------------------- ### GetNumTics Source: https://mhammond.github.io/pywin32/PyCSliderCtrl.html Get the number of tics in the control. ```APIDOC ## GetNumTics ### Description Retrieves the number of tic marks present in the slider control. ### Method (Not specified, likely a getter method) ### Endpoint (Not applicable for SDK methods) ### Parameters (No parameters specified in the source) ### Request Example (Not applicable) ### Response #### Success Response - **num_tics** (int) - The total number of tic marks in the control. ``` -------------------------------- ### win32gui.BeginPath Source: https://mhammond.github.io/pywin32/win32gui__BeginPath_meth.html Initializes a path in a device context. This function is part of the win32gui module and requires a handle to a device context. ```APIDOC ## win32gui.BeginPath ### Description Initializes a path in a device context. ### Method win32gui.BeginPath ### Parameters #### Path Parameters - **_hdc_** (PyHANDLE) - Required - Handle to a device context ``` -------------------------------- ### GetTickCount Source: https://mhammond.github.io/pywin32/win32api.html Returns the milliseconds since Windows started. ```APIDOC ## GetTickCount ### Description Returns the number of milliseconds that have elapsed since the system was started. ### Method Not specified (likely a function call in a library) ### Endpoint Not applicable ### Parameters None specified ### Request Example None specified ### Response #### Success Response - **Return Value** (integer) - The number of milliseconds since system startup. ### Response Example None specified ``` -------------------------------- ### PyIEmptyVolumeCache.Initialize Source: https://mhammond.github.io/pywin32/PyIEmptyVolumeCache.html Initializes the PyIEmptyVolumeCache object. ```APIDOC ## PyIEmptyVolumeCache.Initialize ### Description Initializes the PyIEmptyVolumeCache object. ### Method Not specified (likely called internally by the system) ### Endpoint Not applicable (COM object method) ### Parameters None explicitly documented. ### Response None explicitly documented. ``` -------------------------------- ### StartDebugSession Source: https://mhammond.github.io/pywin32/PyIDebugApplication.html Causes a default debugger IDE to be started. ```APIDOC ## StartDebugSession ### Description Causes a default debugger IDE to be started. ### Method (Not specified in source) ### Endpoint (Not specified in source) ### Parameters (Not specified in source) ### Request Example (Not specified in source) ### Response (Not specified in source) ``` -------------------------------- ### CoCreateInstanceEx Source: https://mhammond.github.io/pywin32/pythoncom.html Create a new instance of an OLE automation server possibly on a remote machine. ```APIDOC ## CoCreateInstanceEx ### Description Create a new instance of an OLE automation server possibly on a remote machine. ### Method (Not specified, likely a Python method call) ### Endpoint (Not applicable) ### Parameters (None specified) ### Request Example (Not applicable) ### Response (Not specified) ``` -------------------------------- ### ReadConsoleOutputCharacter Source: https://mhammond.github.io/pywin32/PyConsoleScreenBuffer.html Reads consecutive characters from a starting position. ```APIDOC ## ReadConsoleOutputCharacter ### Description Reads consecutive characters from a starting position. ### Method Not specified (assumed to be a method call on the PyConsoleScreenBuffer object) ### Endpoint Not applicable (SDK method) ### Parameters None explicitly mentioned. ``` -------------------------------- ### CreateWindowStation Source: https://mhammond.github.io/pywin32/win32service__CreateWindowStation_meth.html Creates a new window station. The name can be None or an empty string to format it from the logon ID. Flags can be CWF_CREATE_ONLY or 0. DesiredAccess is a bitmask of access types for the returned handle. SecurityAttributes specifies the security for the window station and whether the handle is inheritable. ```APIDOC ## CreateWindowStation ### Description Creates a new window station. ### Method Signature `PyHWINSTA = CreateWindowStation(_WindowStation_, Flags_, DesiredAccess_, SecurityAttributes_) ### Parameters #### _WindowStation_ (string) Name of window station to create, or None. #### Flags_ (int) CWF_CREATE_ONLY or 0. #### DesiredAccess_ (int) Bitmask of access types available to returned handle. #### SecurityAttributes_ (PySECURITY_ATTRIBUTES) Specifies security for window station, and whether handle is inheritable. ### Comments If name is None or empty string, name is formatteded from logon id ``` -------------------------------- ### Run Source: https://mhammond.github.io/pywin32/PyIScheduledWorkItem.html Initiates the execution of the scheduled task immediately. ```APIDOC ## Run ### Description Starts the scheduled task immediately. ### Method Not specified (assumed to be a method call on the PyIScheduledWorkItem object) ``` -------------------------------- ### GetTransactionId Source: https://mhammond.github.io/pywin32/win32transaction.html Returns the unique identifier (GUID) of a transaction. ```APIDOC ## GetTransactionId ### Description Returns the unique identifier (GUID) of a transaction. ### Method Not specified (assumed to be a function call in a Python SDK) ### Endpoint Not applicable (SDK function) ### Parameters None explicitly documented. ### Response - **transaction_id** (GUID) - Description: The GUID of the transaction. ``` -------------------------------- ### PSLookupPropertyHandlerCLSID Source: https://mhammond.github.io/pywin32/propsys.html Returns the GUID of the property handler for a file. ```APIDOC ## PSLookupPropertyHandlerCLSID ### Description Returns the GUID of the property handler for a file. ### Method Not specified (likely a function call within the Python module) ### Endpoint Not applicable (Python module function) ### Parameters Not specified in the source text. ### Request Example Not specified in the source text. ### Response Not specified in the source text. ``` -------------------------------- ### PyIEmptyVolumeCache2.InitializeEx Source: https://mhammond.github.io/pywin32/PyIEmptyVolumeCache.html Extended initialization for the PyIEmptyVolumeCache object. ```APIDOC ## PyIEmptyVolumeCache2.InitializeEx ### Description Extended initialization for the PyIEmptyVolumeCache object. This is a gateway implementation. ### Method Not specified (likely called internally by the system) ### Endpoint Not applicable (COM object method) ### Parameters None explicitly documented. ### Response None explicitly documented. ```