[Network DDE is no longer supported. Nddeapi.dll is present on Windows Vista, but all function calls return NDDE_NOT_IMPLEMENTED.]

Retrieves the list of available DDE shares.

Syntax

UINT NDdeShareEnum(
  __in   LPTSTR lpszServer,
  __in   UINT nLevel,
  __out  LPBYTE lpBuffer,
  __in   DWORD cBufSize,
  __out  LPDWORD lpnEntriesRead,
  __out  LPDWORD lpcbTotalAvailable
);

Parameters

lpszServer [in]

The name of the server on which the DSDM resides.

nLevel [in]

Reserved. This parameter must be zero.

lpBuffer [out]

A 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]

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

lpnEntriesRead [out]

A pointer to a variable that receives the total number of shares being enumerated. This parameter cannot be NULL.

lpcbTotalAvailable [out]

A 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 Value

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

See Also

Network Dynamic Data Exchange Overview

Network DDE Functions

Send comments about this topic to Microsoft

Build date: 11/12/2009