This function synchronizes the window in the other pane to the window identified by window. If window is omitted or 0, the current window is used.

Synchronizing the window includes setting the caret in the other window to the specified window's caret and also repositioning the other window so that the lines containing the caret are aligned, if the frame is split horizontally, that is, the windows are separated by a vertical pane.

If the frame is split into more than two windows, window_sync_pane behaves as follows. If window specifies a Document Map window, then the synced pane is the edit (non-Document Map) window which most recently had focus. If window specifies a non-Document Map window, then the corresponding Document Map pane is used if it exists. If there are no Document Map panes in the frame containing window, then the pane which previously had focus is used.

The function returns 1 (True) on success or 0 (False) if nothing was done (for example, there is no other pane or the other pane has a different document).