How to use the comtypes.helpstring function in comtypes

To help you get started, we’ve selected a few comtypes examples, based on popular ways it is used in public projects.

Secure your code as it's written. Use Snyk Code to scan source code in minutes - no build needed - and fix issues immediately.

github ipaleka / arrangeit / arrangeit / windows / vdi.py View on Github external
(["retval", "out"], ctypes.POINTER(ApplicationViewOrientation), "value"),
        ),
        COMMETHOD(
            [helpstring("Method get_AdjacentToLeftDisplayEdge")],
            ctypes.HRESULT,
            "get_AdjacentToLeftDisplayEdge",
            (["retval", "out"], ctypes.POINTER(ctypes.wintypes.BOOL), "value"),
        ),
        COMMETHOD(
            [helpstring("Method get_AdjacentToRightDisplayEdge")],
            ctypes.HRESULT,
            "get_AdjacentToRightDisplayEdge",
            (["retval", "out"], ctypes.POINTER(ctypes.wintypes.BOOL), "value"),
        ),
        COMMETHOD(
            [helpstring("Method get_IsFullScreen")],
            ctypes.HRESULT,
            "get_IsFullScreen",
            (["retval", "out"], ctypes.POINTER(ctypes.wintypes.BOOL), "value"),
        ),
        COMMETHOD(
            [helpstring("Method get_IsOnLockScreen")],
            ctypes.HRESULT,
            "get_IsOnLockScreen",
            (["retval", "out"], ctypes.POINTER(ctypes.wintypes.BOOL), "value"),
        ),
        COMMETHOD(
            [helpstring("Method get_IsScreenCaptureEnabled")],
            ctypes.HRESULT,
            "get_IsScreenCaptureEnabled",
            (["retval", "out"], ctypes.POINTER(ctypes.wintypes.BOOL), "value"),
        ),
github ipaleka / arrangeit / arrangeit / windows / vdi.py View on Github external
COMMETHOD(
            [helpstring("Method GetViewForApplication")],
            ctypes.HRESULT,
            "GetViewForApplication",
            (["in"], ctypes.POINTER(ctypes.wintypes.UINT), "application"),
            (["out"], ctypes.POINTER(ctypes.POINTER(IApplicationView)), "view"),
        ),
        COMMETHOD(
            [helpstring("Method GetViewForAppUserModelId")],
            ctypes.HRESULT,
            "GetViewForAppUserModelId",
            (["in"], ctypes.wintypes.LPCWSTR, "id"),
            (["out"], ctypes.POINTER(ctypes.POINTER(IApplicationView)), "view"),
        ),
        COMMETHOD(
            [helpstring("Method GetViewInFocus")],
            ctypes.HRESULT,
            "GetViewInFocus",
            (["out"], ctypes.POINTER(ctypes.POINTER(IApplicationView)), "view"),
        ),
        COMMETHOD(
            [helpstring("Method Unknown1")],
            ctypes.HRESULT,
            "Unknown1",
            (["out"], ctypes.POINTER(ctypes.POINTER(IApplicationView)), "view"),
        ),
        COMMETHOD(
            [helpstring("Method RefreshCollection")],
            ctypes.HRESULT,
            "RefreshCollection",
        ),
        COMMETHOD(
github ipaleka / arrangeit / arrangeit / windows / vdi.py View on Github external
(["retval", "out"], ctypes.POINTER(ctypes.wintypes.BOOL), "value"),
        ),
        COMMETHOD(
            [helpstring("Method get_IsOnLockScreen")],
            ctypes.HRESULT,
            "get_IsOnLockScreen",
            (["retval", "out"], ctypes.POINTER(ctypes.wintypes.BOOL), "value"),
        ),
        COMMETHOD(
            [helpstring("Method get_IsScreenCaptureEnabled")],
            ctypes.HRESULT,
            "get_IsScreenCaptureEnabled",
            (["retval", "out"], ctypes.POINTER(ctypes.wintypes.BOOL), "value"),
        ),
        COMMETHOD(
            [helpstring("Method put_IsScreenCaptureEnabled")],
            ctypes.HRESULT,
            "put_IsScreenCaptureEnabled",
            (["in"], ctypes.wintypes.BOOL, "value"),
        ),
        COMMETHOD(
            [helpstring("Method put_Title")],
            ctypes.HRESULT,
            "put_Title",
            (["in"], ctypes.POINTER(HSTRING__), "value"),
        ),
        COMMETHOD(
            [helpstring("Method get_Title")],
            ctypes.HRESULT,
            "get_Title",
            (["retval", "out"], ctypes.POINTER(ctypes.POINTER(HSTRING__)), "value"),
        ),
github ipaleka / arrangeit / arrangeit / windows / vdi.py View on Github external
class IVirtualDesktopManagerInternal(comtypes.IUnknown):
    """Interface to methods dealing with virtual dektops documented by community."""

    _case_insensitive_ = True
    _iid_ = IID_IVirtualDesktopManagerInternal
    _idlflags_ = []
    _methods_ = [
        COMMETHOD(
            [helpstring("Method GetCount")],
            ctypes.HRESULT,
            "GetCount",
            (["in"], ctypes.POINTER(ctypes.wintypes.UINT), "pCount"),
        ),
        COMMETHOD(
            [helpstring("Method MoveViewToDesktop")],
            ctypes.HRESULT,
            "MoveViewToDesktop",
            (["in"], ctypes.POINTER(IApplicationView), "pView"),
            (["in"], ctypes.POINTER(IVirtualDesktop), "pDesktop"),
        ),
        COMMETHOD(
            [helpstring("Method CanViewMoveDesktops")],
            ctypes.HRESULT,
            "CanViewMoveDesktops",
            (["out"], ctypes.POINTER(IApplicationView), "pView"),
            (["out"], ctypes.POINTER(ctypes.wintypes.INT), "pfCanViewMoveDesktops"),
        ),
        COMMETHOD(
            [helpstring("Method GetCurrentDesktop")],
            ctypes.HRESULT,
            "GetCurrentDesktop",
github ipaleka / arrangeit / arrangeit / windows / vdi.py View on Github external
_iid_ = IID_IApplicationViewCollection
    _methods_ = [
        COMMETHOD(
            [helpstring("Method GetViews")],
            ctypes.HRESULT,
            "GetViews",
            (["out"], ctypes.POINTER(ctypes.POINTER(IObjectArray)), "array"),
        ),
        COMMETHOD(
            [helpstring("Method GetViewsByZOrder")],
            ctypes.HRESULT,
            "GetViewsByZOrder",
            (["out"], ctypes.POINTER(ctypes.POINTER(IObjectArray)), "array"),
        ),
        COMMETHOD(
            [helpstring("Method GetViewsByAppUserModelId")],
            ctypes.HRESULT,
            "GetViewsByAppUserModelId",
            (["in"], ctypes.wintypes.LPCWSTR, "id"),
            (["out"], ctypes.POINTER(ctypes.POINTER(IObjectArray)), "array"),
        ),
        COMMETHOD(
            [helpstring("Method GetViewForHwnd")],
            ctypes.HRESULT,
            "GetViewForHwnd",
            (["in"], ctypes.wintypes.HWND, "hwnd"),
            (["out"], ctypes.POINTER(ctypes.POINTER(IApplicationView)), "view"),
        ),
        COMMETHOD(
            [helpstring("Method GetViewForApplication")],
            ctypes.HRESULT,
            "GetViewForApplication",
github ipaleka / arrangeit / arrangeit / windows / vdi.py View on Github external
(["out"], ctypes.POINTER(ctypes.wintypes.INT), "pfCanViewMoveDesktops"),
        ),
        COMMETHOD(
            [helpstring("Method GetCurrentDesktop")],
            ctypes.HRESULT,
            "GetCurrentDesktop",
            (["out"], ctypes.POINTER(ctypes.POINTER(IVirtualDesktop)), "desktop"),
        ),
        COMMETHOD(
            [helpstring("Method GetDesktops")],
            ctypes.HRESULT,
            "GetDesktops",
            (["out"], ctypes.POINTER(ctypes.POINTER(IObjectArray)), "ppDesktops"),
        ),
        COMMETHOD(
            [helpstring("Method GetAdjacentDesktop")],
            ctypes.HRESULT,
            "GetAdjacentDesktop",
            (["out"], ctypes.POINTER(IVirtualDesktop), "pDesktopReference"),
            (["in"], AdjacentDesktop, "uDirection"),
            (
                ["out"],
                ctypes.POINTER(ctypes.POINTER(IVirtualDesktop)),
                "ppAdjacentDesktop",
            ),
        ),
        COMMETHOD(
            [helpstring("Method SwitchDesktop")],
            ctypes.HRESULT,
            "SwitchDesktop",
            (["in"], ctypes.POINTER(IVirtualDesktop), "pDesktop"),
        ),
github ipaleka / arrangeit / arrangeit / windows / vdi.py View on Github external
ctypes.HRESULT,
            "get_IsUserInitiated",
            (["retval", "out"], ctypes.POINTER(ctypes.wintypes.BOOL), "value"),
        )
    ]


class IApplicationView(IInspectable):
    """Interface that provides view for the top-level application information."""

    _case_insensitive_ = True
    _iid_ = IID_IApplicationView
    _idlflags_ = []
    _methods_ = [
        COMMETHOD(
            [helpstring("Method get_Orientation")],
            ctypes.HRESULT,
            "get_Orientation",
            (["retval", "out"], ctypes.POINTER(ApplicationViewOrientation), "value"),
        ),
        COMMETHOD(
            [helpstring("Method get_AdjacentToLeftDisplayEdge")],
            ctypes.HRESULT,
            "get_AdjacentToLeftDisplayEdge",
            (["retval", "out"], ctypes.POINTER(ctypes.wintypes.BOOL), "value"),
        ),
        COMMETHOD(
            [helpstring("Method get_AdjacentToRightDisplayEdge")],
            ctypes.HRESULT,
            "get_AdjacentToRightDisplayEdge",
            (["retval", "out"], ctypes.POINTER(ctypes.wintypes.BOOL), "value"),
        ),
github ipaleka / arrangeit / arrangeit / windows / vdi.py View on Github external
),
        COMMETHOD(
            [helpstring("Method CanViewMoveDesktops")],
            ctypes.HRESULT,
            "CanViewMoveDesktops",
            (["out"], ctypes.POINTER(IApplicationView), "pView"),
            (["out"], ctypes.POINTER(ctypes.wintypes.INT), "pfCanViewMoveDesktops"),
        ),
        COMMETHOD(
            [helpstring("Method GetCurrentDesktop")],
            ctypes.HRESULT,
            "GetCurrentDesktop",
            (["out"], ctypes.POINTER(ctypes.POINTER(IVirtualDesktop)), "desktop"),
        ),
        COMMETHOD(
            [helpstring("Method GetDesktops")],
            ctypes.HRESULT,
            "GetDesktops",
            (["out"], ctypes.POINTER(ctypes.POINTER(IObjectArray)), "ppDesktops"),
        ),
        COMMETHOD(
            [helpstring("Method GetAdjacentDesktop")],
            ctypes.HRESULT,
            "GetAdjacentDesktop",
            (["out"], ctypes.POINTER(IVirtualDesktop), "pDesktopReference"),
            (["in"], AdjacentDesktop, "uDirection"),
            (
                ["out"],
                ctypes.POINTER(ctypes.POINTER(IVirtualDesktop)),
                "ppAdjacentDesktop",
            ),
        ),
github ipaleka / arrangeit / arrangeit / windows / vdi.py View on Github external
_methods_ = [
        COMMETHOD(
            [helpstring("Method GetIids")],
            ctypes.HRESULT,
            "GetIids",
            (["out"], ctypes.POINTER(ctypes.wintypes.ULONG), "iidCount"),
            (["out"], ctypes.POINTER(ctypes.POINTER(GUID)), "iids"),
        ),
        COMMETHOD(
            [helpstring("Method GetRuntimeClassName")],
            ctypes.HRESULT,
            "GetRuntimeClassName",
            (["out"], ctypes.POINTER(ctypes.POINTER(HSTRING__)), "className"),
        ),
        COMMETHOD(
            [helpstring("Method GetTrustLevel")],
            ctypes.HRESULT,
            "GetTrustLevel",
            (["out"], ctypes.POINTER(TrustLevel), "trustLevel"),
        ),
    ]


class IApplicationViewConsolidatedEventArgs(IInspectable):
    """Interface providing the results of application view consolidation operations."""

    _case_insensitive_ = True
    _iid_ = IID_IApplicationViewConsolidatedEventArgs
    _idlflags_ = []
    _methods_ = [
        COMMETHOD(
            [helpstring("Method get_IsUserInitiated")],
github ipaleka / arrangeit / arrangeit / windows / vdi.py View on Github external
COMMETHOD(
            [helpstring("Method GetViewForHwnd")],
            ctypes.HRESULT,
            "GetViewForHwnd",
            (["in"], ctypes.wintypes.HWND, "hwnd"),
            (["out"], ctypes.POINTER(ctypes.POINTER(IApplicationView)), "view"),
        ),
        COMMETHOD(
            [helpstring("Method GetViewForApplication")],
            ctypes.HRESULT,
            "GetViewForApplication",
            (["in"], ctypes.POINTER(ctypes.wintypes.UINT), "application"),
            (["out"], ctypes.POINTER(ctypes.POINTER(IApplicationView)), "view"),
        ),
        COMMETHOD(
            [helpstring("Method GetViewForAppUserModelId")],
            ctypes.HRESULT,
            "GetViewForAppUserModelId",
            (["in"], ctypes.wintypes.LPCWSTR, "id"),
            (["out"], ctypes.POINTER(ctypes.POINTER(IApplicationView)), "view"),
        ),
        COMMETHOD(
            [helpstring("Method GetViewInFocus")],
            ctypes.HRESULT,
            "GetViewInFocus",
            (["out"], ctypes.POINTER(ctypes.POINTER(IApplicationView)), "view"),
        ),
        COMMETHOD(
            [helpstring("Method Unknown1")],
            ctypes.HRESULT,
            "Unknown1",
            (["out"], ctypes.POINTER(ctypes.POINTER(IApplicationView)), "view"),