IMailTransportRouterSetLinkState::SetLinkState

[This is preliminary documentation and subject to change.]

Called by a router sink to set a link's state.

HRESULT SetLinkState(
   [in] LPSTR            szLinkDomainName,
   [in] GUID             guidRouterGUID,
   [in] DWORD            dwScheduleID,
   [in] LPSTR            szConnectorName,
   [in] DWORD            dwSetLinkState,
   [in] DWORD            dwUnsetLinkState,
   [in] FILETIME        *pftNextScheduled,
   [in] IMessageRouter  *pMessageRouter
);

szLinkDomainName

The domain name of the link state to set.

guidRouterGUID

The router sink's GUID identifier.

dwScheduleID

szConnectorName

dwSetLinkState

The link state flags to set. Must be some OR'd combination of the eLinkStateFlags enumerated values.

dwUnSetLinkState

The link state flags to un-set. Must be some OR'd combination of the eLinkStateFlags enumerated values.

pftNextScheduled

If the LINK_STATE_SCHED_ENABLED flag is being unset, the next scheduled connection time should be passed by the sink.

pMessageRouter

The IMessageRouter interface reference to the calling sink.

Return Values

Remarks

If LINK_STATE_SCHED_ENABLED is being unset, the next scheduled connection time should be returned in pftNextScheduled parameter.