ホーム › System.ApplicationInstallationAndServicing › FindActCtxSectionStringA

FindActCtxSectionStringA

関数

文字列キーでアクティベーションコンテキスト内のセクション情報を検索する(ANSI版)。

DLLKERNEL32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

// KERNEL32.dll  (ANSI / -A)
#include <windows.h>

BOOL FindActCtxSectionStringA(
    DWORD dwFlags,
    const GUID* lpExtensionGuid,   // optional
    DWORD ulSectionId,
    LPCSTR lpStringToFind,
    ACTCTX_SECTION_KEYED_DATA* ReturnedData
);

パラメーター

名前

型

方向

説明

dwFlags

DWORD

この関数の動作方法を決定するフラグです。現在定義されているのは次のフラグのみです。

値	意味
FIND_ACTCTX_SECTION_KEY_RETURN_HACTCTX	この関数は、リダイレクトデータが見つかったアクティベーションコンテキストのハンドルを、 ACTCTX_SECTION_KEYED_DATA 構造体の hActCtx メンバーに返します。呼び出し元は、このアクティベーションコンテキストを解放するために ReleaseActCtx を使用する必要があります。

lpExtensionGuid

GUID*

optional

予約済みです。null を指定する必要があります。

ulSectionId

DWORD

特定の文字列を検索する対象となる、アクティベーションコンテキストの文字列セクションの識別子です。

有効な文字列セクション識別子は次のとおりです。

lpStringToFind

LPCSTR

検索条件として使用する、null で終わる文字列へのポインターです。

ReturnedData

ACTCTX_SECTION_KEYED_DATA*

out

要求された文字列情報が格納される ACTCTX_SECTION_KEYED_DATA 構造体へのポインターです。

戻り値の型: BOOL

公式ドキュメント

FindActCtxSectionString 関数は、現在のアクティベーションコンテキスト内の特定の文字列に関する情報を取得し、ACTCTX_SECTION_KEYED_DATA 構造体を返します。(ANSI)

戻り値

関数が成功した場合は TRUE を返します。それ以外の場合は FALSE を返します。

この関数は、 GetLastError を呼び出すことで取得できるエラーを設定します。例については、 Retrieving the Last-Error Code を参照してください。エラーコードの完全な一覧については、 System Error Codes を参照してください。

解説(Remarks)

この関数は、サイドバイサイド API 関数または COM メソッドからのみ呼び出す必要があります。アプリケーションがこの関数を直接呼び出すべきではありません。

メモ

winbase.h ヘッダーは、FindActCtxSectionString を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義しています。エンコーディング非依存のエイリアスを、エンコーディング非依存でないコードと混在して使用すると、不整合が生じ、コンパイルエラーまたは実行時エラーを引き起こす可能性があります。詳細については、Conventions for Function Prototypes を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// KERNEL32.dll  (ANSI / -A)
#include <windows.h>

BOOL FindActCtxSectionStringA(
    DWORD dwFlags,
    const GUID* lpExtensionGuid,   // optional
    DWORD ulSectionId,
    LPCSTR lpStringToFind,
    ACTCTX_SECTION_KEYED_DATA* ReturnedData
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool FindActCtxSectionStringA(
    uint dwFlags,   // DWORD
    IntPtr lpExtensionGuid,   // GUID* optional
    uint ulSectionId,   // DWORD
    [MarshalAs(UnmanagedType.LPStr)] string lpStringToFind,   // LPCSTR
    IntPtr ReturnedData   // ACTCTX_SECTION_KEYED_DATA* out
);

<DllImport("KERNEL32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function FindActCtxSectionStringA(
    dwFlags As UInteger,   ' DWORD
    lpExtensionGuid As IntPtr,   ' GUID* optional
    ulSectionId As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPStr)> lpStringToFind As String,   ' LPCSTR
    ReturnedData As IntPtr   ' ACTCTX_SECTION_KEYED_DATA* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' dwFlags : DWORD
' lpExtensionGuid : GUID* optional
' ulSectionId : DWORD
' lpStringToFind : LPCSTR
' ReturnedData : ACTCTX_SECTION_KEYED_DATA* out
Declare PtrSafe Function FindActCtxSectionStringA Lib "kernel32" ( _
    ByVal dwFlags As Long, _
    ByVal lpExtensionGuid As LongPtr, _
    ByVal ulSectionId As Long, _
    ByVal lpStringToFind As String, _
    ByVal ReturnedData As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

FindActCtxSectionStringA = ctypes.windll.kernel32.FindActCtxSectionStringA
FindActCtxSectionStringA.restype = wintypes.BOOL
FindActCtxSectionStringA.argtypes = [
    wintypes.DWORD,  # dwFlags : DWORD
    ctypes.c_void_p,  # lpExtensionGuid : GUID* optional
    wintypes.DWORD,  # ulSectionId : DWORD
    wintypes.LPCSTR,  # lpStringToFind : LPCSTR
    ctypes.c_void_p,  # ReturnedData : ACTCTX_SECTION_KEYED_DATA* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
FindActCtxSectionStringA = Fiddle::Function.new(
  lib['FindActCtxSectionStringA'],
  [
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_VOIDP,  # lpExtensionGuid : GUID* optional
    -Fiddle::TYPE_INT,  # ulSectionId : DWORD
    Fiddle::TYPE_VOIDP,  # lpStringToFind : LPCSTR
    Fiddle::TYPE_VOIDP,  # ReturnedData : ACTCTX_SECTION_KEYED_DATA* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn FindActCtxSectionStringA(
        dwFlags: u32,  // DWORD
        lpExtensionGuid: *const GUID,  // GUID* optional
        ulSectionId: u32,  // DWORD
        lpStringToFind: *const u8,  // LPCSTR
        ReturnedData: *mut ACTCTX_SECTION_KEYED_DATA  // ACTCTX_SECTION_KEYED_DATA* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern bool FindActCtxSectionStringA(uint dwFlags, IntPtr lpExtensionGuid, uint ulSectionId, [MarshalAs(UnmanagedType.LPStr)] string lpStringToFind, IntPtr ReturnedData);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_FindActCtxSectionStringA' -Namespace Win32 -PassThru
# $api::FindActCtxSectionStringA(dwFlags, lpExtensionGuid, ulSectionId, lpStringToFind, ReturnedData)

#uselib "KERNEL32.dll"
#func global FindActCtxSectionStringA "FindActCtxSectionStringA" sptr, sptr, sptr, sptr, sptr
; FindActCtxSectionStringA dwFlags, varptr(lpExtensionGuid), ulSectionId, lpStringToFind, varptr(ReturnedData)   ; 戻り値は stat
; dwFlags : DWORD -> "sptr"
; lpExtensionGuid : GUID* optional -> "sptr"
; ulSectionId : DWORD -> "sptr"
; lpStringToFind : LPCSTR -> "sptr"
; ReturnedData : ACTCTX_SECTION_KEYED_DATA* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "KERNEL32.dll"
#cfunc global FindActCtxSectionStringA "FindActCtxSectionStringA" int, var, int, str, var
; res = FindActCtxSectionStringA(dwFlags, lpExtensionGuid, ulSectionId, lpStringToFind, ReturnedData)
; dwFlags : DWORD -> "int"
; lpExtensionGuid : GUID* optional -> "var"
; ulSectionId : DWORD -> "int"
; lpStringToFind : LPCSTR -> "str"
; ReturnedData : ACTCTX_SECTION_KEYED_DATA* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll"
#cfunc global FindActCtxSectionStringA "FindActCtxSectionStringA" int, sptr, int, str, sptr
; res = FindActCtxSectionStringA(dwFlags, varptr(lpExtensionGuid), ulSectionId, lpStringToFind, varptr(ReturnedData))
; dwFlags : DWORD -> "int"
; lpExtensionGuid : GUID* optional -> "sptr"
; ulSectionId : DWORD -> "int"
; lpStringToFind : LPCSTR -> "str"
; ReturnedData : ACTCTX_SECTION_KEYED_DATA* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。