NDdeShareGetInfo function

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

Retrieves DDE share information. This is usually done for editing.

Syntax

UINT NDdeShareGetInfo(
  _In_  LPTSTR  lpszServer,
  _In_  LPTSTR  lpszShareName,
  _In_  UINT    nLevel,
  _Out_ LPBYTE  lpBuffer,
  _In_  DWORD   cBufSize,
  _Out_ LPDWORD lpnTotalAvailable,
  _In_  LPWORD  lpnItems
);

Parameters

lpszServer [in]

The name of the server on which the DSDM resides.

lpszShareName [in]

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

nLevel [in]

The information level. This parameter must be 2.

lpBuffer [out]

A pointer to a buffer that receives the NDDESHAREINFO structure and associated data pointed to by its members. This parameter 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 [in]

The size of the lpBuffer buffer, in bytes. If lpBuffer is NULL, then cBufSize should be zero.

lpnTotalAvailable [out]

A pointer to a variable that receives the total number of bytes needed to store the requested share information. This parameter cannot be NULL.

lpnItems [in]

A pointer to an item selection mask for partial share information retrieval.

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

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Header	Nddeapi.h
Library	Nddeapi.lib
DLL	Nddeapi.dll
Unicode and ANSI names	NDdeShareGetInfoW (Unicode) and NDdeShareGetInfoA (ANSI)

See also

Network Dynamic Data Exchange Overview

Network DDE Functions

NDDESHAREINFO

NDdeShareSetInfo