DdeQueryStringA-Funktion (ddeml.h)

Artikel
02/29/2024

Kopiert Text, der einem Zeichenfolgenhandle zugeordnet ist, in einen Puffer.

Syntax

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

Parameter

[in] idInst

Art: DWORD

Die Anwendung instance Bezeichner, der durch einen vorherigen Aufruf der DdeInitialize-Funktion abgerufen wurde.

[in] hsz

Typ: HSZ

Ein Handle für die zu kopierende Zeichenfolge. Dieses Handle muss durch einen vorherigen Aufruf der DdeCreateStringHandle-Funktion erstellt worden sein.

[out, optional] psz

Typ: LPTSTR

Ein Zeiger auf einen Puffer, der die Zeichenfolge empfängt. Um die Länge der Zeichenfolge abzurufen, sollte dieser Parameter auf NULL festgelegt werden.

[in] cchMax

Art: DWORD

Die Länge des Puffers in Zeichen, auf den der psz-Parameter verweist. Für die ANSI-Version der Funktion ist dies die Anzahl der Bytes; für die Unicode-Version ist dies die Anzahl der Zeichen. Wenn die Zeichenfolge länger als ( cchMax– 1) ist, wird sie abgeschnitten. Wenn der psz-Parameter auf NULL festgelegt ist, wird dieser Parameter ignoriert.

[in] iCodePage

Typ: int

Die Codepage, die zum Rendern der Zeichenfolge verwendet wird. Dieser Wert sollte entweder CP_WINANSI oder CP_WINUNICODE sein.

Rückgabewert

Art: DWORD

Wenn der psz-Parameter einen gültigen Zeiger angegeben hat, ist der Rückgabewert die Länge des zurückgegebenen Texts in Zeichen (ohne das beendende NULL-Zeichen). Wenn der psz-Parameter einen NULL-Zeiger angegeben hat, ist der Rückgabewert die Länge des Dem hsz-Parameter zugeordneten Texts (ohne das beendende NULL-Zeichen). Wenn ein Fehler auftritt, ist der Rückgabewert 0L.

Hinweise

Die im Puffer zurückgegebene Zeichenfolge ist immer NULL-beendet. Wenn die Zeichenfolge länger als ( cchMax– 1) ist, werden nur die ersten Zeichen ( cchMax– 1) der Zeichenfolge kopiert.

Wenn der psz-ParameterNULL ist, ruft die DdeQueryString-Funktion die Länge (in Bytes) der Zeichenfolge ab, die dem Zeichenfolgenhandle zugeordnet ist. Die Länge enthält nicht das beendende NULL-Zeichen.

Hinweis

Der ddeml.h-Header definiert DdeQueryString als Alias, der die ANSI- oder Unicode-Version dieser Funktion basierend auf der Definition der UNICODE-Präprozessorkonstante automatisch auswählt. Das Mischen der Verwendung des codierungsneutralen Alias mit nicht codierungsneutralem Code kann zu Nichtübereinstimmungen führen, die zu Kompilierungs- oder Laufzeitfehlern führen. Weitere Informationen finden Sie unter Konventionen für Funktionsprototypen.

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Windows 2000 Professional [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows 2000 Server [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	ddeml.h (Einschließen von Windows.h)
Bibliothek	User32.lib
DLL	User32.dll