Edit

Share via

CMSPAddress::GetStaticTerminals method (mspaddr.h)

  • Article

The GetStaticTerminals method is called by our wrapper methods ( get_StaticTerminals and EnumerateStaticTerminals) to get an array of static terminals that can be used on this address. This method updates the address' internal list of terminals by calling UpdateTerminalList if the list is not up to date. If the ppTerminals parameter is NULL or the *pdwNumTerminals parameter is not large enough to hold all the terminal pointers, this method simply returns (as *pdwNumTerminals) the number of terminals available. If ppTerminals is non-NULL and *pdwNumTerminals is large enough, it AddRefs each terminal pointer and places the array of terminal pointers in *ppTerminals, setting *pdwNumTerminals to the number of terminal pointers returned. If the derived MSP wants to change the set of terminals returned, it will probably override UpdateTerminalList rather than overriding this method.

Syntax

HRESULT GetStaticTerminals(
  [out] DWORD      *pdwNumTerminals,
  [out] ITTerminal **ppTerminals
);

Parameters

[out] pdwNumTerminals

Pointer to number of static terminals.

[out] ppTerminals

Pointer to array of ITTerminal interfaces.

Return value

None

Requirements

Requirement Value
Target Platform Windows
Header mspaddr.h

See also

CMSPAddress