GetClipRgn

Declare Function Api_GetClipRgn& Lib "gdi32" Alias "GetClipRgn" (ByVal hDC&, ByVal hRgn&)

Declare Function GetClipRgn Lib "gdi32" (ByVal hdc As Long, ByVal hRgn As Long) As Long

指定されたデバイスコンテキストで、アプリケーションが定義した現在のクリッピングリージョンを取得する。

パラメータ
hdc
    デバイスコンテキストのハンドルを指定する。
hrgn
    この関数を呼び出す前に存在しているリージョンのハンドルを指定する。

    関数から制御が返ると、このパラメータに、現在のクリッピングリージョンのコピーのハンドルが格納される。
　

戻り値
    関数が成功し、指定されたデバイスコンテキストにクリッピングリージョンが存在しない場合、0 が返る。

    関数が成功し、指定されたデバイスコンテキストにクリッピングリージョンが存在する場合、1 が返る。関数が失敗すると、-1 が返る。
    Windows NT/2000：拡張エラー情報を取得するには、GetLastError 関数を使う。

解説
    アプリケーションが定義したクリッピングリージョンとは、SelectClipRgn 関数で指定されたクリッピングリージョンのことである。

    これは、アプリケーションが BeginPaint 関数を呼び出したときに作成されたクリッピングリージョンのことではない。
    GetClipRgn 関数が成功すると、hrgn パラメータには現在のクリッピングリージョンのコピーのハンドルが格納される。

    それ以降、このコピーに変更を加えても、現在のクリッピングリージョンには影響を及ぼさない。