DdeQueryString

The DdeQueryString function copies text associated with a string handle into a buffer.

DWORD DdeQueryString(
  DWORD idInst,  // instance identifier
  HSZ hsz,       // handle to string
  LPTSTR psz,    // pointer to destination buffer
  DWORD cchMax,  // length of buffer
  int iCodePage  // code page identifier
);

Parameters

idInst

[in] Specifies the application instance identifier obtained by a previous call to the DdeInitialize function.

hsz

[in] Handle to the string to copy. This handle must have been created by a previous call to the DdeCreateStringHandle function.

psz

[in/out] Pointer to a buffer that receives the string. To obtain the length of the string, this parameter should be set to NULL.

cchMax

[in] Specifies the length, in TCHARs, of the buffer pointed to by the psz parameter. If the string is longer than (cchMax – 1), it will be truncated. If the psz parameter is set to NULL, this parameter is ignored.

iCodePage

[in] Specifies the code page used to render the string. This value should be either CP_WINANSI or CP_WINUNICODE.

Return Values

If the psz parameter specified a valid pointer, the return value is the length, in TCHARs, of the returned text (not including the terminating null character). If the psz parameter specified a NULL pointer, the return value is the length of the text associated with the hsz parameter (not including the terminating null character). If an error occurs, the return value is 0L.

Remarks

The string returned in the buffer is always null-terminated. If the string is longer than (cchMax – 1), only the first (cchMax – 1) characters of the string are copied.

If the psz parameter is NULL, the DdeQueryString function obtains the length, in bytes, of the string associated with the string handle. The length does not include the terminating null character.

Requirements

  Windows NT/2000: Requires Windows NT 3.1 or later.
  Windows 95/98: Requires Windows 95 or later.
  Header: Declared in Ddeml.h; include Windows.h.
  Library: Use User32.lib.
  Unicode: Implemented as Unicode and ANSI versions on Windows NT/2000.

See Also

Dynamic Data Exchange Management Library Overview, Dynamic Data Exchange Management Functions, DdeCmpStringHandles, DdeCreateStringHandle, DdeFreeStringHandle, DdeInitialize