NDdeShareGetInfo info  Overview  Group

The NDdeShareGetInfo function is called to retrieve DDE share information from the DSDM. This is usually done for editing.

UINT NDdeShareGetInfo(

LPTSTR lpszServer,	// server to execute on
LPTSTR lpszShareName,	// name of share
UINT nLevel,	// info level must be 2
LPBYTE lpBuffer,	// contains (NDDESHAREINFO) + data
DWORD cBufSize,	// size of buffer
LPDWORD lpnTotalAvailable,	// number of bytes available
LPWORD lpnItems	// item mask for partial getinfo
);

Parameters

lpszServer

Address of the server name on which the DSDM resides.

lpszShareName

Address of the share name whose information is to be retrieved from the DSDM. This parameter must not be NULL.

nLevel

Must be 2.

lpBuffer

Address of a buffer that is to accept the NDDESHAREINFO structure and associated data pointed to by NDDESHAREINFO pointer fields. This field can be NULL. If lpBuffer is NULL, then the DSDM calculates the number of bytes required to store the requested share information and returns that value in the lpnTotalAvailable field along with the NDDE_BUF_TOO_SMALL error.

cBufSize

Defines the size of the buffer addressed by the lpBuffer field. If lpBuffer is NULL, then cBufSize should be 0.

lpnTotalAvailable

Address of a varaible that receives the count of the total number of bytes needed to store the requested share information. This parameter must not be NULL.

lpnItems

Address of an item selection mask for partial share information retrieval. For the first release of Windows NT, the item selection mask must be 0.

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.

See Also

NDDESHAREINFO, NDdeShareSetInfo