fungsi wiasParseEndorserString (wiamdef.h)
Fungsi wiasParseEndorserString mengurai string endorser, menggantikan token yang ditentukan layanan WIA dan token yang ditentukan vendor dalam string dengan nilai yang terkait dengan token tersebut.
Sintaks
HRESULT wiasParseEndorserString(
[in] BYTE *pWiasContext,
LONG lFlags,
[out, optional] WIAS_ENDORSER_INFO *pInfo,
[out] BSTR *pOutputString
);
Parameter
[in] pWiasContext
Penunjuk ke konteks Item WIA (konteks item yang berisi properti WIA_DPS_ENDORSER_STRING (dijelaskan dalam dokumentasi Microsoft Windows SDK)).
lFlags
Dicadangkan untuk penggunaan sistem dan harus diatur ke 0.
[out, optional] pInfo
Penunjuk ke struktur WIAS_ENDORSER_INFO yang berisi jumlah halaman dan daftar pasangan token/nilai kustom. Bisa NULL.
[out] pOutputString
Penunjuk ke lokasi memori yang menerima alamat string endorser yang diurai. Jika *pOutputString bukan NULL pada entri, maka fungsi mengasumsikan bahwa pemanggil mengalokasikan buffer; jika tidak, layanan WIA akan mengalokasikannya. Perhatikan bahwa layanan WIA mengasumsikan string dukungan hasil maksimum MAX_PATH (ditentukan dalam stdlib.h) karakter panjang. Jika driver mengharapkan string lebih panjang, itu harus mengalokasikan buffer itu sendiri. Jika penelepon mengalokasikan buffer, pemanggil harus menginisialisasi konten buffer ke nol sebelum menggunakan fungsi ini.
Nilai kembali
Jika berhasil, fungsi mengembalikan S_OK.
Jika fungsi gagal, fungsi mengembalikan kesalahan COM standar atau salah satu kode kesalahan WIA.
Keterangan
Aplikasi menetapkan properti WIA_DPS_ENDORSER_STRING ke string yang dapat berisi token yang ditentukan layanan WIA $DATE$, $TIME$, $PAGE_COUNT$, $DAY$, $MONTH$, dan $YEAR$, serta token yang ditentukan vendor. Setelah driver memanggil wiasParseEndorserString, string yang ditunjukkan oleh pOutputString berisi salinan string di properti WIA_DPS_ENDORSER_STRING, tetapi dengan token apa pun yang digantikan oleh nilai yang diwakili token. Misalnya, jika aplikasi mengatur string endorser ke "Halaman ini dipindai pada $DATE$", dan tanggal saat ini adalah 1 Oktober 2000, string output yang dihasilkan adalah "Halaman ini dipindai pada 2000/10/1".
Daftar token endorser WIA standar dapat ditemukan di wiadef.h.
Driver dapat meminta agar wiasParseEndorserString mengganti nilai untuk token yang ditentukan vendor dengan mengisi struktur WIAS_ENDORSER_VALUE untuk setiap pasangan token/nilai, dan mengemas semua struktur ini dalam struktur WIAS_ENDORSER_INFO . Contoh berikut menunjukkan bagaimana fungsi ini dapat digunakan.
HRESULT hr = S_OK;
BSTR bstrResultingEndorser = NULL;
WIAS_ENDORSER_VALUE aMyTokens[] = {L"$MY_TOKEN$", L"My value"};
WIAS_ENDORSER_INFO Info = {0, 1, aMyTokens};
hr = wiasParseEndorserString(pWiasContext, 0,
&Info, &bstrResultingEndorser);
Dengan asumsi bahwa properti WIA_DPS_ENDORSER_STRING berisi "Ini adalah $MY_TOKEN$", dan bahwa panggilan ke wiasParseEndorserString berhasil, bstrResultingEndorser sekarang akan berisi "Ini adalah Nilai saya".
Persyaratan
| Persyaratan | Nilai |
|---|---|
| Target Platform | Desktop |
| Header | wiamdef.h (termasuk Wiamdef.h) |
| Pustaka | Wiaservc.lib |
| DLL | Wiaservc.dll |