Prev Next

NDdeShareEnum info  Overview  Group

The NDdeShareEnum function is called to list the available DDE shares in the DSDM.

UINT NDdeShareEnum(

    LPTSTR lpszServer,

// server to execute on

    UINT nLevel,

// must be 0

    LPBYTE lpBuffer,

// pointer to buffer

    DWORD cBufSize,

// size of buffer

    LPDWORD lpnEntriesRead,

// number of names returned

    LPDWORD lpcbTotalAvailable 

// number of bytes available

   );

Parameters

lpszServer
Address of the server name on which the DSDM resides.
nLevel
Must be 0.
lpBuffer
Address of a buffer supplied to accept 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 field.
cBufSize
Specifies the size of the supplied buffer addressed by lpBuffer. Must be 0 if lpBuffer is NULL.
lpnEntriesRead
Address of a variable to receive the total number of shares being enumerated. Must not be NULL.
lpcbTotalAvailable
Address of a variable to receive the total number of bytes needed in the buffer to store the list of DDE shares. Must not 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.