ISyncSchedule::GetConnection method

[The ISyncSchedule::GetConnection method is available for use through Windows XP. It is not available in subsequent versions of Windows.]

Gets details about a synchonization schedule's connection.

Syntax

HRESULT GetConnection(
  [in, out] DWORD  *pcbSize,
  [out]     LPWSTR pwszConnectionName,
  [out]     DWORD  *pdwConnType
);

Parameters

pcbSize [in, out]

Type: DWORD*

A pointer to the size, in bytes, of pwszConnectionName. On entry, it is the size of the buffer you provide. On exit, it is the size of the retrieved string.

pwszConnectionName [out]

Type: LPWSTR

A pointer to a buffer that receives the name of the connection.

pdwConnType [out]

Type: DWORD*

A pointer to one of the following values specifying the connection type.

SYNCSCHEDINFO_FLAGS_CONNECTION_LAN (0x0000)

LAN connection.

SYNCSCHEDINFO_FLAGS_CONNECTION_WAN (0x0001)

Wide area network (WAN) connection.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Requirements

Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
End of client support	Windows XP
End of server support	Windows Server 2003
Header	Syncmgr.h
IDL	Syncmgr.idl
DLL	Mobsync.dll