OleGetLinkUpdateOptions

  OLESTATUS OleGetLinkUpdateOptions(lpObject, lpUpdateOpt)    
  LPOLEOBJECT lpObject; /* pointer to object to query */
  OLEOPT_UPDATE FAR* lpUpdateOpt; /* pointer to update options */

The OleGetLinkUpdateOptions function retrieves the link-update options for the specified object.

Parameters

lpObject

Points to the object to query.

lpUpdateOpt

Points to a variable in which the function stores the current value of the link-update option for the specified object. The link option setting may be one of the following:

Option Description

oleupdate_always  
  Update the linked object whenever possible. This option supports the Automatic link-update radio button in the Links dialog box.
oleupdate_onsave  
  Update the linked object when the source document is saved by the server.
oleupdate_oncall  
  Update the linked object only on request from the client application. This option supports the Manual link-update radio button in the Links dialog box.

Return Value

The return value is OLE_OK if the function is successful. Otherwise, it is an error value, which can be OLE_ERROR_OBJECT or OLE_ERROR_STATIC.

See Also

OleSetLinkUpdateOptions