NDdeShareEnum

The NDdeShareEnum function retrieves the list of available DDE shares.

UINT NDdeShareEnum(
  LPTSTR lpszServer,           // server name
  UINT nLevel,                 // must be zero
  LPBYTE lpBuffer,             // buffer
  DWORD cBufSize,              // size of buffer
  LPDWORD lpnEntriesRead,      // number of names returned
  LPDWORD lpcbTotalAvailable   // number of bytes available
);

Parameters

lpszServer

[in] Pointer to a string that specifies the name of the server on which the DSDM resides.

nLevel

[in] This parameter must be zero.

lpBuffer

[out] Pointer to a buffer that receives the list of DDE shares. The list of DDE shares is stored as a sequence of null-separated strings terminating with a double null at the end. This parameter can be NULL. If lpBuffer is NULL, the DSDM returns the size of buffer required to hold the list of shares in the lpcbTotalAvailable parameter.

cBufSize

[in] Specifies the size of the lpBuffer buffer, in bytes. This parameter must be zero if lpBuffer is NULL.

lpnEntriesRead

[out] Pointer to a variable that receives the total number of shares being enumerated. This parameter cannot be NULL.

lpcbTotalAvailable

[out] Pointer to a variable that receives the total number of bytes needed in the buffer to store the list of DDE shares. This parameter cannot be NULL.

Return Values

If the function succeeds, the return value is NDDE_NO_ERROR.

If the function fails, the return value is an error code, which can be translated into a text error message by calling NDdeGetErrorString. If the lpBuffer parameter is NULL, it returns NDDE_BUF_TOO_SMALL.

Requirements

  Windows NT/2000: Requires Windows NT 3.1 or later.
  Header: Declared in Nddeapi.h.
  Library: Use Nddeapi.lib.
  Unicode: Implemented as Unicode and ANSI versions on Windows NT/2000.

See Also

Network Dynamic Data Exchange Overview, Network DDE Functions