DoEventsとSleep関数の仕組みをしっかり理解したい

Question

以下、(1)社内サイトからダウンロードしたExcelファイルを開く、(2)開いたエクセルファイルを取得するコードです（動作はOK）。

（★）のDoEventsとSleep 100の部分について、

• DoEventsのみだと、「ブックは取得できませんでした」となる
• Sleep 100を入れると、正常動作する

のですが、この挙動の違いを**DoEventsとSleep関数の仕組みの違いから理解**をしたく。

以下いろいろ調べたところの、私の推測です。
補足等、詳しくご説明頂ける方がいれば是非よろしくお願いいたします。

私の推測

ブックを開く処理と、本コードの実行は、同じプロセス（Excel）であるが、スレッドが異なる。
ブックを開く処理を実施するためには、制御をVBA→OSに移す必要がある。

DoEventsで、制御をVBA→OSに移すが、ココによると、DoEventsは0.02秒しか、制御を移せない。
したがって、追加で直後に、Sleep 100を入れることで、0.1秒Sleepさせる。

Sleep関数は、「処理を停止」する関数なので、この関数を入れることで、別スレッド（ブックを開く）が実行できる？
（どこを読んでも、「処理を停止させる」程度の説明なのでここの理解がぼんやりしています）

コード

・
・
（省略）
・
・
'(1)社内サイトからダウンロードしたExcelファイルを開く
Dim o As IUIAutomation
Dim e As IUIAutomationElement
Set o = New CUIAutomation
Dim h As LongPtr
h = ie.hwnd
h = FindWindowEx(h, 0, "Frame Notification Bar", vbNullString)
If h = 0 Then Exit Sub

Set e = o.ElementFromHandle(ByVal h)
Dim iCnd As IUIAutomationCondition
Set iCnd = o.CreatePropertyCondition(UIA_NamePropertyId, "ファイルを開く")

Dim Button As IUIAutomationElement
Dim InvokePattern As IUIAutomationInvokePattern

While InvokePattern Is Nothing
DoEvents
Set Button = e.FindFirst(TreeScope_Subtree, iCnd)
Set InvokePattern = Button.GetCurrentPattern(UIA_InvokePatternId)
Wend
InvokePattern.Invoke '『開く』ボタンを押すコード


'(2)自動で開かれたワークブックオブジェクトを取得する
Dim wb As Workbook
Dim isFound As Boolean
isFound = False

Dim i As Long
For i = 1 To 10000
    For Each wb In Workbooks
        If wb.Name = "ダウンロードして開いたブック名.csv" Then
            Set new_wb = Workbooks("ダウンロードして開いたブック名.csv")
            isFound = True
            Exit For
        End If
    Next
    If isFound Then
        Exit For
    Else
        DoEvents　（★）
        Sleep 100
    End If
Next

If Not isFound Then
    MsgBox "開いたブックを取得できませんでした。"
    Exit Sub
End If

Debug.Print wb.Name & "取得できました"

Answer 1

挙動の違いをDoEventsとSleep関数の仕組みの違いから理解をしたく。

DoEventsで非同期処理の完了の催促、Sleepはその結果をどの程度待つかです。
矢継ぎ早に催促だけして、結果を確認しているという状況ですね。

根本的な理解として必要な事は、同期/非同期です。

(1)社内サイトから自動でExcelファイルを開き

この処理が非同期であるから、待ち合わせの為の処理が必要になるわけで、同期処理として実行できれば、待ち合わせは不要になります。

どのような処理を行っているのか不明なので、役立つか分かりませんが以下参考に。
VBAで他のアプリケーションを同期起動する（WshShell）

DoEvents 関数

DoEvents はオペレーティング システムに制御を渡します。 オペレーティング システムがキュー内のイベントの処理を終了し、SendKeys キューのすべてのキーが送信された後、制御が戻されます。

上記は、自身の処理への割り当てを返却し、他の処理を優先させると読み替える事が出来ます。
ただ、「SendKeys キューのすべてのキーが送信された」状態は、「他の処理の全てが完了した」と同義ではありません。

Comments

[koyamashinji]

sazi様、ご回答誠にありがとうございます。
また、参考リンクも頂き有難うございます。

「(1)社内サイトから自動でExcelファイルを開き」
この部分をもう少し具体的に説明すると、
データベースからCSV形式のデータをダウンロードし（3-4秒程度かかる）、
IEのダウンロード通知バーの「開く」を押してからExcelブックを開く処理です。

> DoEventsで非同期処理の完了の催促、Sleepはその結果をどの程度待つかです。
以上の文脈の中では、
DoEventsにて、0.02秒x 10,000回ループ=最大200秒間、非同期処理の(1)のスレッドを実行できるので、
普通、200秒間以内に(1)の処理は完了する為、sleepせずとも開けるのではないかと思ってしまいます。

同期、非同期については、知識不足で色々と調べていますが、
いまいち、「催促」と「待つ」の違いに理解が及ばず。
もしよろしければ詳しく教えて頂けないでしょうか。

[sazi]

実際の動作から、DoEventsはキューイングされているわけではないと推測しています。
単にその瞬間に制御がOSに渡るだけ。
そう考えると、sleepなしに実行しても意味が無い事になっている結果と辻褄が合います。
sleepを挟むことで、OSがDoEventsを拾って処理する機会を増やしているという事です。

[YAmaGNZ]

質問文とコメントを見て思ったのですが、DoEventsで0.2秒待機するような勘違いをされているように読めます。
DoEventsでかかる時間は特に決まっていません。
なので、「ある一定時間待つ」という意味合いでDoEventsを使うのは間違っています。

[koyamashinji]

YAmaGNZ様、
ご指摘有難うございます。
>DoEventsでかかる時間は特に決まっていません。
DoEventsでかかる時間というのは、何に依存しているのでしょうか。

[YAmaGNZ]

DoEventsはそのUIスレッドで未処理のイベントメッセージを処理する為の命令と考えた方がいいかと思います。
なので、処理すべきイベントの数やその内容、マシンスペックによって時間は変わります。

Answer 2

DoEventsとSleepの違いですが、単純に言うと

DoEventsは自分の溜まったイベントを処理する為のもの
Sleepは指定時間の間、自分の処理を止めて、他のスレッドやアプリケーションにCPUを空け渡す

といった感じになります。

参考にされたページのものをループを増やして実行してみれば分かるのですが、DoEventsの処理の方はUIを操作でき、Sleepのほうは操作ができないかと思います。

Comments

[koyamashinji]

ご説明頂き有難うございます。
・今回のケースにおける、「イベント」の理解が曖昧です。
「ブックを開く」イベントは、「『開く』ボタンを押すコード（※質問文に追記しました）」が実行された時点で発生済だと思いますが、その他の操作を一切しない場合、１回目のループでDoEventsに辿り着いた時点で「溜まったイベント」とは何を指すのでしょうか。

[YAmaGNZ]

ここでいうイベントメッセージとは主にOSがアプリケーションに対して「マウスが動いた」とか「表示しろ」などを通知するためのメッセージを指します。
例えば、MouseMoveのイベントの処理を行っていなかったとしても、OSからは「マウスが動いた」という事象はイベントメッセージとして通知されます。
このOSから通知されるメッセージは、VBAの場合は内部で処理され意識することはほぼありませんが、自分が作成したコードと同一スレッドで動作する為、自分で作成したソースが動いている間はイベントメッセージが処理できなくなってしまいます。
なので、自分の処理が途中の時にイベントメッセージを一旦処理してもらおうというのがDoEventsになります。
たとえば、ループで1000件のデータを処理して、その進行度を画面に表示しようとした場合
For i = 1 To 1000
'処理
Label1.Caption = i & "件"
Next
とすると、Label1のテキストは処理が終わった後に更新されます。
これは、Label1のテキストを変更した時に「再描画しろ」とイベントメッセージが来ているのですが、こちらはループの処理を行っているのでメッセージの処理ができません。
この為、ループが終わってイベントメッセージが処理できるようになってから「再描画しろ」というイベントメッセージが処理され実際に再描画されます。
このループ内にDoEventsを入れると、そのたびにイベントメッセージを処理するようになるので「再描画しろ」というイベントメッセージは1回のループごとに処理されます。

また、DoEventsを呼んだときに処理すべきイベントメッセージが何もなければ処理しないだけです。

[koyamashinji]

ご丁寧に大変分かりやすい説明有難うございます。
おかげ様で、DoEventsの仕組みがだんだんと理解できてきました。
（まだ頭の中を整理中ですが・・・。）

MouseMoveのイベント処理に係る時間はほんの「一瞬」（マウスポインタを別の場所に描画するだけ）であるのに対し、
ブックを開くイベント処理には「『開く』ボタンを押す～ブックが完全に開く」まで比較的長時間（5秒程度）かかります。

後者のイベント処理には時間を要する為（重い処理である）、CPUを空け渡してあげることが必要であることから、DoEventsの直後にSleep関数が必要、との理解で間違ってないでしょうか。
逆に言えば、MouseMoveのイベント処理のみであれば、sleep関数は不要？

[YAmaGNZ]

MouseMoveの処理だけのことを書きますが
１．マウスカーソルを動かす
２．OSがマウスカーソルが座標Aに動かされたということを検知し、マウスカーソルの位置を更新する
３．OSは動作しているアプリケーションに対してマウスカーソルが動かされたということをメッセージで通知する
４．アプリケーションが自分のメッセージを受け取る処理で３のマウスカーソルが動かされたというメッセージを受け取りキューに保存する
５．受け取ったキューの中身を確認し、もしMouseMoveイベントを発生させる必要があるならMouseMoveイベントを発生させる
６．MouseMoveイベントハンドラの処理が行われる
７．受信したメッセージがなくなるまで５～６の処理を行う
といった流れが大まかな流れとなります。

もし、ループなどで処理を行っていたら上記でいう５～が動作しなくなります。
この時、OSからのマウスカーソルが動かされたというメッセージはキューに保存されて、忘れてしまうわけではありません。
そして時間がかかる処理が終わったりした時に、そのキューに保存されていたメッセージが処理され５～の処理が行われます。
DoEventsはDoEventsを呼んだタイミングで５～の処理を実行します。これが私の説明で「自分の溜まったイベントを処理する」と言っている部分になります。
なので、DoEventsにかかる時間は５～７にあるように、受信したメッセージの量、処理すべき内容、イベントハンドラ内で実行させるべき処理によって変化することになります。

MouseMoveイベントの処理にどれくらいかかるかはMouseMoveイベントのイベントハンドラに書いた処理次第です。
ただマウスカーソルの座標を変数に入れるという処理であれば一瞬でしょうが、もしこのMouseMoveのイベントハンドラに10秒かかる処理があった場合はDoEventsに10秒かかることになりますし、マウスカーソルの座標をメッセージボックスで表示するという処理にした場合、メッセージボックスを閉じるまでの時間がかかります。

DoEventsはあくまで自分自身の処理をどうするかというものです。
（実行したときに他のスレッド、アプリケーションなどにCPUを明け渡すかもしれませんが、これは主目的ではなく副作用であって必ずこうなるという期待して使用するべきではありません）

また、Sleepは先の説明にあるように「指定時間自分の処理を止めて、他のスレッドやアプリケーションにCPUを空け渡す」というものです。

ループでセットで使用するのは
１．他で処理を行う
２．１の結果や待った時間の間に起こった自分自身のイベントを処理する
というのを繰り返すということで、自分自身のループ内部の処理に専念するのではなく、他の処理にもCPUを使わせるし、自分宛のメッセージも処理しながらループ内部の処理を行うということです。

[koyamashinji]

たびたびご丁寧な回答深謝致します。

今回の、ブックを開く際の状況に当てはめると、
ブックを開くコードが実行された時点では、４．の状態であって、正確にはイベントは発生しておらず、アプリケーション（Excel）のキューに保存されたのみである。１回目のDoEventsに到達した際に、初めて「開く」というイベントを発生させる（５．の部分）、との理解をしました。

>MouseMoveのイベントハンドラに10秒かかる処理があった場合はDoEventsに10秒かかることになりま>す

今回の「ブックを開く」という処理には先述のとおり５秒程度かかりますので、「ブックを開く」というイベントハンドラに５秒かかる。と解釈すると、ループ１回目のDoEventsで、5秒かけてブックを開くのを完了してくれるのでは、と思ってしまいます。

大変、理解が悪く誠に申し訳ございません。今回のブックを開く、という例に基づき、イベント処理の機序をご説明頂けないでしょうか。ご無理を申し上げて恐縮です。

[YAmaGNZ]

＞今回の「ブックを開く」という処理には先述のとおり５秒程度かかりますので、「ブックを開く」というイベントハンドラに５秒かかる。と解釈すると、ループ１回目のDoEventsで、5秒かけてブックを開くのを完了してくれるのでは、と思ってしまいます。

再三言っていますが、DoEventsは時間を待つ時に使うものではありません。
5秒待つのであればSleepを使ってください。
そして、待つときにSleep(5000)と単純に5秒待つとUIが反応しなくなります。
なので
For i=1 To 50
Sleep(100)
DoEvents
Next
といった感じでSleepを短時間にしてDoEventsを挟むことによって自分のイベントを処理できるようにします。

[koyamashinji]

ご丁寧に教えていただきまして、大変感謝しています。今回、おかげ様でかなり理解が深まりました。これからも勉強させて頂きます。

[sazi]

@koyamashinzjiさん
どのような場合にイベントが発生し、どのような順番で行われるかを理解した上で、イベント処理を実装されている場合を除き、DoEventsを使用する場合は、他にイベント処理を行っていないケースでの使用をお薦めします。
また、回答したとおりDoEventsを採用するより、同期処理を行うようにした方が、イベントの沼に嵌るのを回避できますので。

[koyamashinji]

sazi様、
追加のご助言を頂きまして、誠に有難うございます。同期／非同期処理の概念を全く存じ上げておりませんでしたので、大変勉強になりました。同期処理での実装にもトライしてみようと思います。また、よろしくお願いいたします。（ベストアンサーにできず申し明けございません。下名にとっては、両者ともベストアンサーです）

[sazi]

BAについては気になさらずに。イベントの沼経験者としては同じように嵌って欲しくなかったのでコメントしたのです。

[koyamashinji]

sazi様、大変有難うございます。もっと勉強致します。

Answer 3

Workbooksオブジェクトの内容が明らかにされていないし、ループを1万回繰り返してわざとPCに負荷をかけている理由も全く分からないのですが、
単純に、Sleepがない場合、「If wb.Name = "ダウンロードして開いたブック名.csv"」がTrueになる前にFor文の1万回リピートが終わってしまい、
isFound が True にならないので
正常動作していないように見えるだけなのではないのでしょうか？