Fungsi panggilan balik MAPILOGON (mapi.h)

[Penggunaan fungsi ini tidak dianjurkan. Ini bisa diubah atau tidak tersedia dalam versi Windows berikutnya.]

Fungsi MAPILogon memulai sesi MAPI Sederhana, memuat penyimpanan pesan default dan penyedia buku alamat.

Sintaks

MAPILOGON Mapilogon;

ULONG Mapilogon(
  [in]           ULONG_PTR ulUIParam,
  [in, optional] LPSTR lpszProfileName,
  [in, optional] LPSTR lpszPassword,
  [in]           FLAGS flFlags,
                 ULONG ulReserved,
  [out]          LPLHANDLE lplhSession
)
{...}

Parameter

[in] ulUIParam

Handel jendela induk atau nol, menunjukkan bahwa jika kotak dialog ditampilkan, itu adalah modal aplikasi. Jika parameter ulUIParam berisi handel jendela induk, parameter tersebut berjenis HWND (dilemparkan ke ULONG_PTR). Jika tidak ada kotak dialog yang ditampilkan selama panggilan, ulUIParam diabaikan.

[in, optional] lpszProfileName

Penunjuk ke string nama profil yang dihentikan null, dibatasi hingga 256 karakter atau kurang. Ini adalah profil yang digunakan saat masuk. Jika parameter lpszProfileNameadalah NULL atau menunjuk ke string kosong, dan parameter flFlags diatur ke MAPI_LOGON_UI, MAPILogon menampilkan kotak dialog masuk dengan bidang nama kosong.

[in, optional] lpszPassword

Penunjuk ke string kredensial yang dihentikan null, dibatasi hingga 256 karakter atau kurang. Jika sistem olahpesan tidak memerlukan kredensial kata sandi, atau jika mengharuskan pengguna memasukkannya, parameter lpszPassword harus NULL atau menunjuk ke string kosong. Ketika pengguna harus memasukkan kredensial, parameter flFlags harus diatur ke MAPI_LOGON_UI untuk memungkinkan kotak dialog masuk ditampilkan.

[in] flFlags

Bitmask dari bendera opsi. Bendera berikut dapat diatur.

Nilai	Makna
MAPI_FORCE_DOWNLOAD	Upaya harus dilakukan untuk mengunduh semua pesan pengguna sebelum kembali. Jika bendera MAPI_FORCE_DOWNLOAD tidak diatur, pesan dapat diunduh di latar belakang setelah panggilan fungsi kembali.
MAPI_NEW_SESSION	Upaya harus dilakukan untuk membuat sesi baru daripada memperoleh sesi bersama lingkungan. Jika bendera MAPI_NEW_SESSION tidak diatur, MAPILogon menggunakan sesi bersama yang ada.
MAPI_LOGON_UI	Kotak dialog masuk harus ditampilkan untuk meminta informasi masuk kepada pengguna. Jika pengguna perlu memberikan kata sandi dan nama profil untuk mengaktifkan masuk yang berhasil, MAPI_LOGON_UI harus diatur.
MAPI_PASSWORD_UI	MAPILogon hanya boleh meminta kata sandi dan tidak mengizinkan pengguna untuk mengubah nama profil. Baik MAPI_PASSWORD_UI atau MAPI_LOGON_UI tidak boleh diatur, karena niatnya adalah memilih di antara dua kotak dialog yang berbeda untuk masuk.

ulReserved

Dipesan; harus nol.

[out] lplhSession

Handel sesi MAPI sederhana.

Nilai kembali

Fungsi ini mengembalikan salah satu nilai berikut.

Menampilkan kode	Deskripsi
MAPI_E_FAILURE	Terjadi satu atau beberapa kesalahan yang tidak ditentukan selama masuk. Tidak ada handel sesi yang dikembalikan.
MAPI_E_INSUFFICIENT_MEMORY	Memori tidak cukup untuk melanjutkan. Tidak ada handel sesi yang dikembalikan.
MAPI_E_LOGIN_FAILURE	Tidak ada log masuk default, dan pengguna gagal masuk dengan sukses ketika kotak dialog masuk ditampilkan. Tidak ada handel sesi yang dikembalikan.
MAPI_E_TOO_MANY_SESSIONS	Pengguna memiliki terlalu banyak sesi yang terbuka secara bersamaan. Tidak ada handel sesi yang dikembalikan.
MAPI_E_USER_ABORT	Pengguna membatalkan kotak dialog masuk. Tidak ada handel sesi yang dikembalikan.
SUCCESS_SUCCESS	Panggilan berhasil dan sesi MAPI Sederhana dibuat.

Keterangan

Fungsi MAPILogon memulai sesi dengan sistem olahpesan, mengembalikan handel yang dapat digunakan dalam panggilan MAPI berikutnya untuk secara eksplisit memberikan kredensial pengguna ke sistem olahpesan. Untuk meminta tampilan kotak dialog masuk jika kredensial yang disajikan gagal memvalidasi sesi, atur parameter flFlags ke MAPI_LOGON_UI.

Aplikasi klien menguji sesi yang ada dengan memanggil MAPILogon dengan nilai NULL untuk parameter lpszProfileName , nilai NULL untuk parameter lpszPassword dan dengan tidak mengatur bendera MAPI_LOGON_UI di flFlags. Jika ada sesi yang ada, panggilan berhasil dan mengembalikan LHANDLE yang valid untuk sesi tersebut. Jika tidak, panggilan gagal.

Persyaratan

Persyaratan	Nilai
Target Platform	Windows
Header	mapi.h

Lihat juga

MAPILogoff

MAPI Sederhana