DdeQueryStringA-Funktion (ddeml.h)

Artikel
11/20/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

Typ: DWORD-

Der Anwendungsinstanzbezeichner, 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 zu erhalten, sollte dieser Parameter auf NULL-festgelegt werden.

[in] cchMax

Typ: 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 Codeseite, die zum Rendern der Zeichenfolge verwendet wird. Dieser Wert sollte entweder CP_WINANSI oder CP_WINUNICODEsein.

Rückgabewert

Typ: DWORD-

Wenn der psz Parameter einen gültigen Zeiger angegeben hat, ist der Rückgabewert die Länge des zurückgegebenen Texts (nicht einschließlich des endenden Nullzeichens). Wenn der psz Parameter einen NULL- Zeiger angegeben hat, ist der Rückgabewert die Länge des Texts, der dem hsz-Parameter zugeordnet ist (nicht einschließlich des endenden Nullzeichens). Wenn ein Fehler auftritt, lautet der Rückgabewert 0L.

Bemerkungen

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

Wenn der psz Parameter NULList, ruft die DdeQueryString-Funktion die Länge der Zeichenfolge in Bytes ab, die dem Zeichenfolgenhandle zugeordnet ist. Die Länge enthält nicht das endende Nullzeichen.

Anmerkung

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 Code, der nicht codierungsneutral ist, 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
mindestens unterstützte Client-	Windows 2000 Professional [nur Desktop-Apps]
mindestens unterstützte Server-	Windows 2000 Server [nur Desktop-Apps]
Zielplattform-	Fenster
Header-	ddeml.h (enthalten Windows.h)
Library	User32.lib
DLL-	User32.dll