McastApiStartup

The McastApiStartup function facilitates MADCAP-version negotiation between requesting clients and the version of MADCAP implemented on the system. Calling McastApiStartup allocates necessary resources; it must be called before any other MADCAP client functions are called.

DWORD APIENTRY McastApiStartup(
  PDWORD pVersion
);

Parameters

pVersion

[in] Pointer to the version of multicast (MCAST) that the client wishes to use.

[out] Pointer to the version of MCAST implemented on the system.

Remarks

Clients can specify which version they want to use in the pVersion parameter. If the system's implementation supports the requested MCAST version, the function call succeeds. If the system's implementation does not support the requested version, the function fails with MCAST_API_CURRENT_VERSION.

The client can automatically negotiate the first version of MCAST (MCAST_API_VERSION_1) by setting the pVersion parameter to zero.

The McastApiStartup function always returns the most recent version of MADCAP available on the system (MCAST_API_CURRENT_VERSION) in pVersion, enabling clients to discover the most recent version implemented on the system.

Return Values

If the client requests a version of MADCAP that is not supported by the system, the McastApiStartup function returns ERROR_NOT_SUPPORTED. If resources fail to be allocated for the function call, ERROR_NO_SYSTEM_RESOURCES is returned.

Requirements

  Windows NT/2000: Requires Windows 2000.
  Header: Declared in Madcapcl.h.