DdeQueryStringA 関数 (ddeml.h)

  • [アーティクル]

文字列ハンドルに関連付けられているテキストをバッファーにコピーします。

構文

DWORD DdeQueryStringA(
  [in]            DWORD idInst,
  [in]            HSZ   hsz,
  [out, optional] LPSTR psz,
  [in]            DWORD cchMax,
  [in]            int   iCodePage
);

パラメーター

[in] idInst

型: DWORD

DdeInitialize 関数の前回の呼び出しによって取得されたアプリケーション インスタンス識別子。

[in] hsz

種類: HSZ

コピーする文字列のハンドル。 このハンドルは、 DdeCreateStringHandle 関数の以前の呼び出しによって作成されている必要があります。

[out, optional] psz

種類: LPTSTR

文字列を受け取るバッファーへのポインター。 文字列の長さを取得するには、このパラメーターを NULL に設定する必要があります。

[in] cchMax

型: DWORD

psz パラメーターが指すバッファーの長さ (文字数)。 ANSI バージョンの関数の場合、これはバイト数です。Unicode バージョンの場合、これは文字数です。 文字列が ( cchMax– 1) より長い場合は、切り捨てられます。 psz パラメーターが NULL に設定されている場合、このパラメーターは無視されます。

[in] iCodePage

型: int

文字列のレンダリングに使用されるコード ページ。 この値は 、CP_WINANSI または CP_WINUNICODEにする必要があります。

戻り値

型: DWORD

psz パラメーターが有効なポインターを指定した場合、戻り値は、返されるテキストの長さ (終端の null 文字を含まない) です。 psz パラメーターで NULL ポインターを指定した場合、戻り値は hsz パラメーターに関連付けられたテキストの長さになります (終端の null 文字は含まれません)。 エラーが発生した場合、戻り値は 0L です。

注釈

バッファーで返される文字列は常に null で終了します。 文字列が ( cchMax – 1) より長い場合は、文字列の最初の ( cchMax – 1) 文字のみがコピーされます。

psz パラメーターが NULL の場合、DdeQueryString 関数は、文字列ハンドルに関連付けられている文字列の長さをバイト単位で取得します。 この長さには、終端の null 文字は含まれません。

注意

ddeml.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして DdeQueryString を定義します。 エンコードに依存しないエイリアスをエンコードニュートラルでないコードと組み合わせて使用すると、コンパイルまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。

要件

要件 値
サポートされている最小のクライアント Windows 2000 Professional [デスクトップ アプリのみ]
サポートされている最小のサーバー Windows 2000 Server [デスクトップ アプリのみ]
対象プラットフォーム Windows
ヘッダー ddeml.h (Windows.h を含む)
Library User32.lib
[DLL] User32.dll

関連項目

概念

DdeCmpStringHandles

DdeCreateStringHandle

DdeFreeStringHandle

DdeInitialize

動的データ交換管理ライブラリ

参照