Edit

IRichEditOle::SetLinkAvailable method (richole.h)

  • Article

Sets the value of the link-available bit in the object's flags. The link-available bit defaults to TRUE. It should be set to FALSE if any errors occur on the link which would indicate problems connecting to the linked object or application. When those problems are repaired, the bit should be set to TRUE again.

Syntax

HRESULT SetLinkAvailable(
  LONG iob,
  BOOL fAvailable
);

Parameters

iob

Type: LONG

Index of object whose bit is to be set. If this parameter is REO_IOB_SELECTION, the bit on the selected object is to be set.

fAvailable

Type: BOOL

Value used in the set operation. The value can be TRUE or FALSE.

Return value

Type: HRESULT

Returns S_OK on success, or a failure code otherwise. E_INVALIDARG is returned if the index is invalid.

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header richole.h
DLL Msftedit.dll

See also

IRichEditOle