~ubuntu-branches/ubuntu/natty/gnome-vfs/natty

<indexterm zone="GNOME-VFS-MODULE-CALLBACK-FILL-AUTHENTICATION--CAPS"><primary sortas="GNOME_VFS_MODULE_CALLBACK_FILL_AUTHENTICATION">GNOME_VFS_MODULE_CALLBACK_FILL_AUTHENTICATION</primary></indexterm><programlisting>#define GNOME_VFS_MODULE_CALLBACK_FILL_AUTHENTICATION "fill-authentication"

<indexterm zone="GNOME-VFS-MODULE-CALLBACK-FILL-AUTHENTICATION:CAPS"><primary>GNOME_VFS_MODULE_CALLBACK_FILL_AUTHENTICATION</primary></indexterm>

<programlisting>#define GNOME_VFS_MODULE_CALLBACK_FILL_AUTHENTICATION "fill-authentication"

</programlisting>

<para>

A module callback name used together with <link linkend="gnome-vfs-module-callback-invoke"><function>gnome_vfs_module_callback_invoke()</function></link> to

<para>

The login data consists of a username, a password and a domain, and is used to

access a resource. If the data is not suitable for accessing the resource, the

module callback to query the user right after the authentication failed.

</para>

<para>

A <link linkend="GnomeVFSModuleCallbackFillAuthenticationOut"><type>GnomeVFSModuleCallbackFillAuthenticationOut</type></link> * passing the cached

keyring data (i.e. username/password etc.) back to the module. Usually,

this is data that was stored using <link linkend="GNOME-VFS-MODULE-CALLBACK-SAVE-AUTHENTICATION--CAPS"><type>GNOME_VFS_MODULE_CALLBACK_SAVE_AUTHENTICATION</type></link>,

this is data that was stored using <link linkend="GNOME-VFS-MODULE-CALLBACK-SAVE-AUTHENTICATION:CAPS"><type>GNOME_VFS_MODULE_CALLBACK_SAVE_AUTHENTICATION</type></link>,

and is either stored permanently on disk or cached.

100

</simpara>

101

</listitem>

103

105

</para></refsect2>

104

106

105

107

<title>GnomeVFSModuleCallbackFillAuthenticationIn</title>

106

<indexterm zone="GnomeVFSModuleCallbackFillAuthenticationIn"><primary sortas="GnomeVFSModuleCallbackFillAuthenticationIn">GnomeVFSModuleCallbackFillAuthenticationIn</primary></indexterm><programlisting>typedef struct {

108

<indexterm zone="GnomeVFSModuleCallbackFillAuthenticationIn"><primary>GnomeVFSModuleCallbackFillAuthenticationIn</primary></indexterm>

109

<programlisting>typedef struct {

107

110

char *uri;

108

111

char *protocol;

109

112

char *server;

116

119

</programlisting>

117

120

<para>

118

121

A pointer to a <link linkend="GnomeVFSModuleCallbackFillAuthenticationIn"><type>GnomeVFSModuleCallbackFillAuthenticationIn</type></link> structure is passed to the

119

122

120

123

about the authentication parameters that should be requested from the user.

121

124

</para>

122

125

<para>

123

The <link linkend="GNOME-VFS-MODULE-CALLBACK-FILL-AUTHENTICATION--CAPS"><type>GNOME_VFS_MODULE_CALLBACK_FILL_AUTHENTICATION</type></link> application callback will then set

126

The <link linkend="GNOME-VFS-MODULE-CALLBACK-FILL-AUTHENTICATION:CAPS"><type>GNOME_VFS_MODULE_CALLBACK_FILL_AUTHENTICATION</type></link> application callback will then set

124

127

the members of a pointer to a <link linkend="GnomeVFSModuleCallbackFillAuthenticationOut"><type>GnomeVFSModuleCallbackFillAuthenticationOut</type></link> structure

125

128

according to the stored or cached data.</para>

126

129

<para>

127

130

</para><variablelist role="struct">

128

131

129

132

130

133

<listitem><simpara> The textual URI of the resource that requires authentication.

131

134

</simpara></listitem>

132

135

</varlistentry>

133

136

134

<term><link linkend="char">char</link> *<structfield>protocol</structfield>;</term>

137

<term><link linkend="char">char</link> *<structfield id="GnomeVFSModuleCallbackFillAuthenticationIn.protocol">protocol</structfield>;</term>

135

138

<listitem><simpara> One of the protocols supported by the invoking module.

136

139

Typically matches <parameter>uri</parameter>'s protocol.

137

140

</simpara></listitem>

138

141

</varlistentry>

139

142

140

<term><link linkend="char">char</link> *<structfield>server</structfield>;</term>

143

<term><link linkend="char">char</link> *<structfield id="GnomeVFSModuleCallbackFillAuthenticationIn.server">server</structfield>;</term>

141

144

<listitem><simpara> The server that contains the resource that requires authentication.

142

145

Typically matches <parameter>uri</parameter>'s hostname.

143

146

</simpara></listitem>

144

147

</varlistentry>

145

148

146

<term><link linkend="char">char</link> *<structfield>object</structfield>;</term>

149

<term><link linkend="char">char</link> *<structfield id="GnomeVFSModuleCallbackFillAuthenticationIn.object">object</structfield>;</term>

147

150

<listitem><simpara> The type of the resource that requires authentication.

148

151

</simpara></listitem>

149

152

</varlistentry>

150

153

151

154

152

155

<listitem><simpara> The port that was used to connect to <parameter>server</parameter>. 0 means unset.

153

156

</simpara></listitem>

154

157

</varlistentry>

155

158

156

<term><link linkend="char">char</link> *<structfield>authtype</structfield>;</term>

159

<term><link linkend="char">char</link> *<structfield id="GnomeVFSModuleCallbackFillAuthenticationIn.authtype">authtype</structfield>;</term>

157

160

<listitem><simpara> The type of authentication that was requested. For the

158

161

HTTP method, this may be "basic" or "proxy". For the SFTP method,

159

162

this may be "publickey" or "password".

160

163

</simpara></listitem>

161

164

</varlistentry>

162

165

163

<term><link linkend="char">char</link> *<structfield>username</structfield>;</term>

166

<term><link linkend="char">char</link> *<structfield id="GnomeVFSModuleCallbackFillAuthenticationIn.username">username</structfield>;</term>

164

167

<listitem><simpara> The username that was used to connect to <parameter>server</parameter>.

165

168

</simpara></listitem>

166

169

</varlistentry>

167

170

168

<term><link linkend="char">char</link> *<structfield>domain</structfield>;</term>

171

<term><link linkend="char">char</link> *<structfield id="GnomeVFSModuleCallbackFillAuthenticationIn.domain">domain</structfield>;</term>

169

172

<listitem><simpara> The domain that <parameter>server</parameter> belongs to (only used by the SMB method).

170

173

</simpara></listitem>

171

174

</varlistentry>

172

175

</variablelist></refsect2>

173

176

174

177

<title>GnomeVFSModuleCallbackFillAuthenticationOut</title>

175

<indexterm zone="GnomeVFSModuleCallbackFillAuthenticationOut"><primary sortas="GnomeVFSModuleCallbackFillAuthenticationOut">GnomeVFSModuleCallbackFillAuthenticationOut</primary></indexterm><programlisting>typedef struct {

178

<indexterm zone="GnomeVFSModuleCallbackFillAuthenticationOut"><primary>GnomeVFSModuleCallbackFillAuthenticationOut</primary></indexterm>

179

<programlisting>typedef struct {

176

180

gboolean valid;

177

181

char *username;

178

182

char *domain;

181

185

</programlisting>

182

186

<para>

183

187

A pointer to a <link linkend="GnomeVFSModuleCallbackFillAuthenticationOut"><type>GnomeVFSModuleCallbackFillAuthenticationOut</type></link> structure is passed to the

184

188

185

189

about the authentication parameters that were found in the cache or permanently stored.

186

190

</para>

187

191

<para>

188

The login data returned by <link linkend="GNOME-VFS-MODULE-CALLBACK-FILL-AUTHENTICATION--CAPS"><type>GNOME_VFS_MODULE_CALLBACK_FILL_AUTHENTICATION</type></link> was usually

189

previously stored using #<link linkend="GNOME-VFS-MODULE-CALLBACK-SAVE-AUTHENTICATION--CAPS"><type>GNOME_VFS_MODULE_CALLBACK_SAVE_AUTHENTICATION</type></link>.</para>

192

The login data returned by <link linkend="GNOME-VFS-MODULE-CALLBACK-FILL-AUTHENTICATION:CAPS"><type>GNOME_VFS_MODULE_CALLBACK_FILL_AUTHENTICATION</type></link> was usually

193

previously stored using #<link linkend="GNOME-VFS-MODULE-CALLBACK-SAVE-AUTHENTICATION.:CAPS"><type>GNOME_VFS_MODULE_CALLBACK_SAVE_AUTHENTICATION.</type></link></para>

190

194

<para>

191

195

</para><variablelist role="struct">

192

196

193

<term><link linkend="gboolean">gboolean</link> <structfield>valid</structfield>;</term>

197

<term><link linkend="gboolean">gboolean</link> <structfield id="GnomeVFSModuleCallbackFillAuthenticationOut.valid">valid</structfield>;</term>

194

198

<listitem><simpara> Whether stored or cached login data was found for the resource referenced by

195

199

the <link linkend="GnomeVFSModuleCallbackFillAuthenticationIn"><type>GnomeVFSModuleCallbackFillAuthenticationIn</type></link> structure.

196

200

</simpara></listitem>

197

201

</varlistentry>

198

202

199

<term><link linkend="char">char</link> *<structfield>username</structfield>;</term>

203

<term><link linkend="char">char</link> *<structfield id="GnomeVFSModuleCallbackFillAuthenticationOut.username">username</structfield>;</term>

200

204

<listitem><simpara> The cached username that should be used to access the resource.

201

205

This will be freed by the module when it isn't needed any longer. May only

202

be set if <parameter>valid</parameter> is <link linkend="TRUE--CAPS"><literal>TRUE</literal></link>.

206

be set if <parameter>valid</parameter> is <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>.

203

207

</simpara></listitem>

204

208

</varlistentry>

205

209

206

<term><link linkend="char">char</link> *<structfield>domain</structfield>;</term>

210

<term><link linkend="char">char</link> *<structfield id="GnomeVFSModuleCallbackFillAuthenticationOut.domain">domain</structfield>;</term>

207

211

<listitem><simpara> The cached domain that should be used to access the resource.

208

212

This will be freed by the module when it isn't needed any longer. May only

209

be set if <parameter>valid</parameter> is <link linkend="TRUE--CAPS"><literal>TRUE</literal></link>.

213

be set if <parameter>valid</parameter> is <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>.

210

214

</simpara></listitem>

211

215

</varlistentry>

212

216

213

<term><link linkend="char">char</link> *<structfield>password</structfield>;</term>

217

<term><link linkend="char">char</link> *<structfield id="GnomeVFSModuleCallbackFillAuthenticationOut.password">password</structfield>;</term>

214

218

<listitem><simpara> The cached password that should be used to access the resource.

215

219

This will be freed by the module when it isn't needed any longer. May only

216

be set if <parameter>valid</parameter> is <link linkend="TRUE--CAPS"><literal>TRUE</literal></link>.

220

be set if <parameter>valid</parameter> is <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>.

217

221

</simpara></listitem>

218

222

</varlistentry>

219

223

</variablelist></refsect2>

220

224

221

225

<title>GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION</title>

222

<indexterm zone="GNOME-VFS-MODULE-CALLBACK-FULL-AUTHENTICATION--CAPS"><primary sortas="GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION">GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION</primary></indexterm><programlisting>#define GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION "full-authentication"

226

<indexterm zone="GNOME-VFS-MODULE-CALLBACK-FULL-AUTHENTICATION:CAPS"><primary>GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION</primary></indexterm>

227

<programlisting>#define GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION "full-authentication"

223

228

</programlisting>

224

229

<para>

225

230

A module callback name used together with <link linkend="gnome-vfs-module-callback-invoke"><function>gnome_vfs_module_callback_invoke()</function></link> to

249

254

</para></refsect2>

250

255

251

256

<title>enum GnomeVFSModuleCallbackFullAuthenticationFlags</title>

252

<indexterm zone="GnomeVFSModuleCallbackFullAuthenticationFlags"><primary sortas="GnomeVFSModuleCallbackFullAuthenticationFlags">GnomeVFSModuleCallbackFullAuthenticationFlags</primary></indexterm><programlisting>typedef enum {

257

<indexterm zone="GnomeVFSModuleCallbackFullAuthenticationFlags"><primary>GnomeVFSModuleCallbackFullAuthenticationFlags</primary></indexterm>

258

<programlisting>typedef enum {

253

259

GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION_PREVIOUS_ATTEMPT_FAILED = 1<<0,

254

260

GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION_NEED_PASSWORD = 1<<1,

255

261

GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION_NEED_USERNAME = 1<<2,

259

265

} GnomeVFSModuleCallbackFullAuthenticationFlags;

260

266

</programlisting>

261

267

<para>

262

These flags will be passed to the <link linkend="GNOME-VFS-MODULE-CALLBACK-FULL-AUTHENTICATION--CAPS"><type>GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION</type></link> callback,

268

These flags will be passed to the <link linkend="GNOME-VFS-MODULE-CALLBACK-FULL-AUTHENTICATION:CAPS"><type>GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION</type></link> callback,

263

269

as part of the <link linkend="GnomeVFSModuleCallbackFullAuthenticationIn"><type>GnomeVFSModuleCallbackFullAuthenticationIn</type></link> structure. The output data

264

270

will be stored in a <link linkend="GnomeVFSModuleCallbackFullAuthenticationOut"><type>GnomeVFSModuleCallbackFullAuthenticationOut</type></link> structure.</para>

265

271

<para>

266

272

</para><variablelist role="enum">

267

273

268

274

<term><literal>GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION_PREVIOUS_ATTEMPT_FAILED</literal></term>

269

275

<listitem><simpara> This is not the first login attempt,

270

276

i.e. this callback was already invoked but the provided login data was not suitable for a successful login.

271

277

</simpara></listitem>

272

278

</varlistentry>

273

279

274

280

<term><literal>GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION_NEED_PASSWORD</literal></term>

275

281

<listitem><simpara> The application should ask the user for

276

a password and set the <parameter>password</parameter> field of <link linkend="GnomeVFSModuleCallbackFullAuthenticationOut"><type>GnomeVFSModuleCallbackFullAuthenticationOut</type></link>.

282

a password and set the <parameter>password</parameter> field of <link linkend="GnomeVFSModuleCallbackFullAuthenticationOut."><type>GnomeVFSModuleCallbackFullAuthenticationOut.</type></link>

277

283

</simpara></listitem>

278

284

</varlistentry>

279

285

280

286

<term><literal>GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION_NEED_USERNAME</literal></term>

281

287

<listitem><simpara> The application should ask the user for

282

a username and set the <parameter>username</parameter> field of <link linkend="GnomeVFSModuleCallbackFullAuthenticationOut"><type>GnomeVFSModuleCallbackFullAuthenticationOut</type></link>.

288

a username and set the <parameter>username</parameter> field of <link linkend="GnomeVFSModuleCallbackFullAuthenticationOut."><type>GnomeVFSModuleCallbackFullAuthenticationOut.</type></link>

283

289

</simpara></listitem>

284

290

</varlistentry>

285

291

286

292

<term><literal>GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION_NEED_DOMAIN</literal></term>

287

293

<listitem><simpara> The application should ask the user for

288

a domain and set the <parameter>domain</parameter> field of <link linkend="GnomeVFSModuleCallbackFullAuthenticationOut"><type>GnomeVFSModuleCallbackFullAuthenticationOut</type></link>.

294

a domain and set the <parameter>domain</parameter> field of <link linkend="GnomeVFSModuleCallbackFullAuthenticationOut."><type>GnomeVFSModuleCallbackFullAuthenticationOut.</type></link>

289

295

</simpara></listitem>

290

296

</varlistentry>

291

297

292

298

<term><literal>GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION_SAVING_SUPPORTED</literal></term>

293

299

<listitem><simpara> The application may ask the user

294

300

whether he wants to save the password. If this flag is not present, or the user does not want to

295

301

save the password, the application must set the <parameter>save_password</parameter> field of <link linkend="GnomeVFSModuleCallbackFullAuthenticationOut"><type>GnomeVFSModuleCallbackFullAuthenticationOut</type></link>

296

to <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> and its keyring field to <link linkend="NULL--CAPS"><literal>NULL</literal></link>. If the <parameter>save_password</parameter> field is <link linkend="TRUE--CAPS"><literal>TRUE</literal></link>, the module invoking

297

the <link linkend="GNOME-VFS-MODULE-CALLBACK-FULL-AUTHENTICATION--CAPS"><type>GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION</type></link> callback is expected to invoke the

298

299

the <parameter>username</parameter>, <parameter>password</parameter>, <parameter>domain</parameter> and <parameter>keyring</parameter> fields of <link linkend="GnomeVFSModuleCallbackFullAuthenticationOut"><type>GnomeVFSModuleCallbackFullAuthenticationOut</type></link>.

302

to <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> and its keyring field to <link linkend="NULL:CAPS"><literal>NULL</literal></link>. If the <parameter>save_password</parameter> field is <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>, the module invoking

303

the <link linkend="GNOME-VFS-MODULE-CALLBACK-FULL-AUTHENTICATION:CAPS"><type>GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION</type></link> callback is expected to invoke the

304

305

the <parameter>username</parameter>, <parameter>password</parameter>, <parameter>domain</parameter> and <parameter>keyring</parameter> fields of <link linkend="GnomeVFSModuleCallbackFullAuthenticationOut."><type>GnomeVFSModuleCallbackFullAuthenticationOut.</type></link>

300

306

</simpara></listitem>

301

307

</varlistentry>

302

308

303

309

<term><literal>GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION_ANON_SUPPORTED</literal></term>

304

310

<listitem><simpara> The application

305

311

should offer the user a choice to login anonymously (used for example by the FTP module).

306

If the user requests anonymous login, <link linkend="GNOME-VFS-MODULE-CALLBACK-FULL-AUTHENTICATION-OUT-ANON-SELECTED--CAPS"><type>GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION_OUT_ANON_SELECTED</type></link>

307

must be set in the <parameter>out_flags</parameter> field of <link linkend="GnomeVFSModuleCallbackFullAuthenticationOut"><type>GnomeVFSModuleCallbackFullAuthenticationOut</type></link>.

312

If the user requests anonymous login, <link linkend="GNOME-VFS-MODULE-CALLBACK-FULL-AUTHENTICATION-OUT-ANON-SELECTED:CAPS"><type>GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION_OUT_ANON_SELECTED</type></link>

313

must be set in the <parameter>out_flags</parameter> field of <link linkend="GnomeVFSModuleCallbackFullAuthenticationOut."><type>GnomeVFSModuleCallbackFullAuthenticationOut.</type></link>

308

314

</simpara></listitem>

309

315

</varlistentry>

310

316

</variablelist></refsect2>

311

317

312

318

<title>GnomeVFSModuleCallbackFullAuthenticationIn</title>

313

<indexterm zone="GnomeVFSModuleCallbackFullAuthenticationIn"><primary sortas="GnomeVFSModuleCallbackFullAuthenticationIn">GnomeVFSModuleCallbackFullAuthenticationIn</primary></indexterm><programlisting>typedef struct {

319

<indexterm zone="GnomeVFSModuleCallbackFullAuthenticationIn"><primary>GnomeVFSModuleCallbackFullAuthenticationIn</primary></indexterm>

320

<programlisting>typedef struct {

314

321

GnomeVFSModuleCallbackFullAuthenticationFlags flags;

315

322

316

323

char *uri;

329

336

</programlisting>

330

337

<para>

331

338

A pointer to a <link linkend="GnomeVFSModuleCallbackFullAuthenticationIn"><type>GnomeVFSModuleCallbackFullAuthenticationIn</type></link> structure is passed to the

332

339

333

340

about the authentication parameters that should be requested from the user.

334

341

</para>

335

342

<para>

336

The <link linkend="GNOME-VFS-MODULE-CALLBACK-FULL-AUTHENTICATION--CAPS"><type>GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION</type></link> application callback will then set

343

The <link linkend="GNOME-VFS-MODULE-CALLBACK-FULL-AUTHENTICATION:CAPS"><type>GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION</type></link> application callback will then set

337

344

the members of a pointer to a <link linkend="GnomeVFSModuleCallbackFullAuthenticationOut"><type>GnomeVFSModuleCallbackFullAuthenticationOut</type></link> structure

338

345

according to the user input.</para>

339

346

<para>

340

347

</para><variablelist role="struct">

341

348

342

<term><link linkend="GnomeVFSModuleCallbackFullAuthenticationFlags">GnomeVFSModuleCallbackFullAuthenticationFlags</link> <structfield>flags</structfield>;</term>

349

<term><link linkend="GnomeVFSModuleCallbackFullAuthenticationFlags">GnomeVFSModuleCallbackFullAuthenticationFlags</link> <structfield id="GnomeVFSModuleCallbackFullAuthenticationIn.flags">flags</structfield>;</term>

343

350

<listitem><simpara> <link linkend="GnomeVFSModuleCallbackFullAuthenticationFlags"><type>GnomeVFSModuleCallbackFullAuthenticationFlags</type></link> influencing the user query.

344

351

</simpara></listitem>

345

352

</varlistentry>

346

353

347

354

348

355

<listitem><simpara> The textual URI of the resource that requires authentication.

349

356

</simpara></listitem>

350

357

</varlistentry>

351

358

352

<term><link linkend="char">char</link> *<structfield>protocol</structfield>;</term>

359

<term><link linkend="char">char</link> *<structfield id="GnomeVFSModuleCallbackFullAuthenticationIn.protocol">protocol</structfield>;</term>

353

360

<listitem><simpara> One of the protocols supported by the invoking module. Typically matches <parameter>uri</parameter>'s protocol.

354

361

</simpara></listitem>

355

362

</varlistentry>

356

363

357

<term><link linkend="char">char</link> *<structfield>server</structfield>;</term>

364

<term><link linkend="char">char</link> *<structfield id="GnomeVFSModuleCallbackFullAuthenticationIn.server">server</structfield>;</term>

358

365

<listitem><simpara> The server that contains the resource that requires authentication. Typically matches <parameter>uri</parameter>'s hostname.

359

366

</simpara></listitem>

360

367

</varlistentry>

361

368

362

<term><link linkend="char">char</link> *<structfield>object</structfield>;</term>

369

<term><link linkend="char">char</link> *<structfield id="GnomeVFSModuleCallbackFullAuthenticationIn.object">object</structfield>;</term>

363

370

<listitem><simpara> The type of the resource that requires authentication.

364

371

</simpara></listitem>

365

372

</varlistentry>

366

373

367

374

368

375

<listitem><simpara> The port that was used to connect to <parameter>server</parameter>. 0 means unset.

369

376

</simpara></listitem>

370

377

</varlistentry>

371

378

372

<term><link linkend="char">char</link> *<structfield>authtype</structfield>;</term>

379

<term><link linkend="char">char</link> *<structfield id="GnomeVFSModuleCallbackFullAuthenticationIn.authtype">authtype</structfield>;</term>

373

380

<listitem><simpara> The type of authentication that was requested. For the

374

381

HTTP method, this may be "basic" or "proxy". For the SFTP method,

375

382

this may be "publickey" or "password".

376

383

</simpara></listitem>

377

384

</varlistentry>

378

385

379

<term><link linkend="char">char</link> *<structfield>username</structfield>;</term>

386

<term><link linkend="char">char</link> *<structfield id="GnomeVFSModuleCallbackFullAuthenticationIn.username">username</structfield>;</term>

380

387

<listitem><simpara> The username that was used to connect to <parameter>server</parameter>. This variable

381

388

should just be used for display purposes, i.e. like <quote>You were trying

382

389

to access foo<parameter>bar.com</parameter></quote> where foo is the <parameter>username</parameter> and bar.com is the

386

393

</simpara></listitem>

387

394

</varlistentry>

388

395

389

<term><link linkend="char">char</link> *<structfield>domain</structfield>;</term>

396

<term><link linkend="char">char</link> *<structfield id="GnomeVFSModuleCallbackFullAuthenticationIn.domain">domain</structfield>;</term>

390

397

<listitem><simpara> The domain that <parameter>server</parameter> belongs to (only used by the SMB method).

391

398

This variable should just be used for display purposes where foo is the <parameter>username</parameter>

392

399

and bar.com is the <parameter>server</parameter>. Do not make the contents of the

396

403

</simpara></listitem>

397

404

</varlistentry>

398

405

399

<term><link linkend="char">char</link> *<structfield>default_user</structfield>;</term>

406

<term><link linkend="char">char</link> *<structfield id="GnomeVFSModuleCallbackFullAuthenticationIn.default_user">default_user</structfield>;</term>

400

407

<listitem><simpara> The username that should be provided to the user by default.

401

408

Typically matches <parameter>username</parameter>.

402

409

</simpara></listitem>

403

410

</varlistentry>

404

411

405

<term><link linkend="char">char</link> *<structfield>default_domain</structfield>;</term>

412

<term><link linkend="char">char</link> *<structfield id="GnomeVFSModuleCallbackFullAuthenticationIn.default_domain">default_domain</structfield>;</term>

406

413

<listitem><simpara> The domain that should be provided to the user by default.

407

414

Typically matches <parameter>domain</parameter>.

408

415

</simpara></listitem>

410

417

</variablelist></refsect2>

411

418

412

419

<title>GnomeVFSModuleCallbackFullAuthenticationOut</title>

413

<indexterm zone="GnomeVFSModuleCallbackFullAuthenticationOut"><primary sortas="GnomeVFSModuleCallbackFullAuthenticationOut">GnomeVFSModuleCallbackFullAuthenticationOut</primary></indexterm><programlisting>typedef struct {

420

<indexterm zone="GnomeVFSModuleCallbackFullAuthenticationOut"><primary>GnomeVFSModuleCallbackFullAuthenticationOut</primary></indexterm>

421

<programlisting>typedef struct {

414

422

gboolean abort_auth;

415

423

416

424

char *username;

425

433

</programlisting>

426

434

<para>

427

435

A pointer to a <link linkend="GnomeVFSModuleCallbackFullAuthenticationOut"><type>GnomeVFSModuleCallbackFullAuthenticationOut</type></link> structure is passed to the

428

436

429

437

about the authentication parameters that the user provided by setting the respective

430

438

fields according to the user input and the passed-in <link linkend="GnomeVFSModuleCallbackFullAuthenticationIn"><type>GnomeVFSModuleCallbackFullAuthenticationIn</type></link>

431

439

pointer.</para>

432

440

<para>

433

441

</para><variablelist role="struct">

434

442

435

<term><link linkend="gboolean">gboolean</link> <structfield>abort_auth</structfield>;</term>

443

<term><link linkend="gboolean">gboolean</link> <structfield id="GnomeVFSModuleCallbackFullAuthenticationOut.abort_auth">abort_auth</structfield>;</term>

436

444

<listitem><simpara> Whether the user somehow cancelled the login process. The application

437

445

is expected to offer the user a cancellation point during the authentication query.

438

446

In a graphical user interface, this is typically achieved by providing a "Cancel"

440

448

</simpara></listitem>

441

449

</varlistentry>

442

450

443

<term><link linkend="char">char</link> *<structfield>username</structfield>;</term>

451

<term><link linkend="char">char</link> *<structfield id="GnomeVFSModuleCallbackFullAuthenticationOut.username">username</structfield>;</term>

444

452

<listitem><simpara> The user-provided username that should be used to access the resource

445

referenced by <link linkend="GnomeVFSModuleCallbackFullAuthenticationIn"><type>GnomeVFSModuleCallbackFullAuthenticationIn</type></link>. This will be freed by

453

referenced by <link linkend="GnomeVFSModuleCallbackFullAuthenticationIn."><type>GnomeVFSModuleCallbackFullAuthenticationIn.</type></link> This will be freed by

446

454

the module when it isn't needed any longer. Must not be set if the

447

455

448

456

449

457

</simpara></listitem>

450

458

</varlistentry>

451

459

452

<term><link linkend="char">char</link> *<structfield>domain</structfield>;</term>

460

<term><link linkend="char">char</link> *<structfield id="GnomeVFSModuleCallbackFullAuthenticationOut.domain">domain</structfield>;</term>

453

461

<listitem><simpara> The user-provided domain that should be used to access the resource

454

referenced by <link linkend="GnomeVFSModuleCallbackFullAuthenticationIn"><type>GnomeVFSModuleCallbackFullAuthenticationIn</type></link>. This will be freed by

462

referenced by <link linkend="GnomeVFSModuleCallbackFullAuthenticationIn."><type>GnomeVFSModuleCallbackFullAuthenticationIn.</type></link> This will be freed by

455

463

the module when it isn't needed any longer. Must not be set if the

456

464

457

465

458

466

</simpara></listitem>

459

467

</varlistentry>

460

468

461

<term><link linkend="char">char</link> *<structfield>password</structfield>;</term>

469

<term><link linkend="char">char</link> *<structfield id="GnomeVFSModuleCallbackFullAuthenticationOut.password">password</structfield>;</term>

462

470

<listitem><simpara> The user-provided password that should be used to access the resource

463

referenced by <link linkend="GnomeVFSModuleCallbackFullAuthenticationIn"><type>GnomeVFSModuleCallbackFullAuthenticationIn</type></link>. This will be freed by

471

referenced by <link linkend="GnomeVFSModuleCallbackFullAuthenticationIn."><type>GnomeVFSModuleCallbackFullAuthenticationIn.</type></link> This will be freed by

464

472

the module when it isn't needed any longer. Must not be set if the

465

473

466

474

467

475

</simpara></listitem>

468

476

</varlistentry>

469

477

470

<term><link linkend="gboolean">gboolean</link> <structfield>save_password</structfield>;</term>

478

<term><link linkend="gboolean">gboolean</link> <structfield id="GnomeVFSModuleCallbackFullAuthenticationOut.save_password">save_password</structfield>;</term>

471

479

<listitem><simpara> Flags whether the user requested to save the provided login

472

data. Must be <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> if the <link linkend="GnomeVFSModuleCallbackFullAuthenticationFlags"><type>GnomeVFSModuleCallbackFullAuthenticationFlags</type></link>

473

don't contain <link linkend="GNOME-VFS-MODULE-CALLBACK-FULL-AUTHENTICATION-SAVING-SUPPORTED--CAPS"><type>GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION_SAVING_SUPPORTED</type></link>.

480

data. Must be <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> if the <link linkend="GnomeVFSModuleCallbackFullAuthenticationFlags"><type>GnomeVFSModuleCallbackFullAuthenticationFlags</type></link>

481

don't contain <link linkend="GNOME-VFS-MODULE-CALLBACK-FULL-AUTHENTICATION-SAVING-SUPPORTED.:CAPS"><type>GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION_SAVING_SUPPORTED.</type></link>

474

482

</simpara></listitem>

475

483

</varlistentry>

476

484

477

<term><link linkend="char">char</link> *<structfield>keyring</structfield>;</term>

485

<term><link linkend="char">char</link> *<structfield id="GnomeVFSModuleCallbackFullAuthenticationOut.keyring">keyring</structfield>;</term>

478

486

<listitem><simpara> Flags which keyring should be used to save the password. This will

479

later be passed to the <link linkend="GNOME-VFS-MODULE-CALLBACK-SAVE-AUTHENTICATION--CAPS"><type>GNOME_VFS_MODULE_CALLBACK_SAVE_AUTHENTICATION</type></link> callback

487

later be passed to the <link linkend="GNOME-VFS-MODULE-CALLBACK-SAVE-AUTHENTICATION:CAPS"><type>GNOME_VFS_MODULE_CALLBACK_SAVE_AUTHENTICATION</type></link> callback

480

488

if the login attempt was successful with the specified <parameter>username</parameter>, <parameter>password</parameter> and

481

489

<parameter>domain</parameter>. This will NOT be freed by the module, so the application typically

482

provides a <link linkend="NULL--CAPS"><literal>NULL</literal></link> pointer or a pointer to a static string.

490

provides a <link linkend="NULL:CAPS"><literal>NULL</literal></link> pointer or a pointer to a static string.

483

491

</simpara></listitem>

484

492

</varlistentry>

485

493

486

<term><link linkend="gsize">gsize</link> <structfield>out_flags</structfield>;</term>

494

<term><link linkend="gsize">gsize</link> <structfield id="GnomeVFSModuleCallbackFullAuthenticationOut.out_flags">out_flags</structfield>;</term>

487

495

<listitem><simpara> <link linkend="GnomeVFSModuleCallbackFullAuthenticationOutFlags"><type>GnomeVFSModuleCallbackFullAuthenticationOutFlags</type></link> signalling a special request, for instance

488

496

anonymous access to an FTP server.

489

497

</simpara></listitem>

491

499

</variablelist></refsect2>

492

500

493

501

<title>enum GnomeVFSModuleCallbackFullAuthenticationOutFlags</title>

494

<indexterm zone="GnomeVFSModuleCallbackFullAuthenticationOutFlags"><primary sortas="GnomeVFSModuleCallbackFullAuthenticationOutFlags">GnomeVFSModuleCallbackFullAuthenticationOutFlags</primary></indexterm><programlisting>typedef enum {

502

<indexterm zone="GnomeVFSModuleCallbackFullAuthenticationOutFlags"><primary>GnomeVFSModuleCallbackFullAuthenticationOutFlags</primary></indexterm>

503

<programlisting>typedef enum {

495

504

GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION_OUT_ANON_SELECTED = 1<<0

496

505

} GnomeVFSModuleCallbackFullAuthenticationOutFlags;

497

506

</programlisting>

498

507

<para>

499

These flags will be passed from a <link linkend="GNOME-VFS-MODULE-CALLBACK-FULL-AUTHENTICATION--CAPS"><type>GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION</type></link> callback

508

These flags will be passed from a <link linkend="GNOME-VFS-MODULE-CALLBACK-FULL-AUTHENTICATION:CAPS"><type>GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION</type></link> callback

500

509

back to the module, as part of the <link linkend="GnomeVFSModuleCallbackFullAuthenticationOut"><type>GnomeVFSModuleCallbackFullAuthenticationOut</type></link> structure.</para>

501

510

<para>

502

511

</para><variablelist role="enum">

503

512

504

513

<term><literal>GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION_OUT_ANON_SELECTED</literal></term>

505

514

<listitem><simpara> Anonymous login requested.

506

515

May only be set if the <link linkend="GnomeVFSModuleCallbackFullAuthenticationIn"><type>GnomeVFSModuleCallbackFullAuthenticationIn</type></link>'s

507

516

508

517

509

518

</simpara></listitem>

510

519

</varlistentry>

511

520

</variablelist></refsect2>

512

521

513

522

<title>GNOME_VFS_MODULE_CALLBACK_SAVE_AUTHENTICATION</title>

514

<indexterm zone="GNOME-VFS-MODULE-CALLBACK-SAVE-AUTHENTICATION--CAPS"><primary sortas="GNOME_VFS_MODULE_CALLBACK_SAVE_AUTHENTICATION">GNOME_VFS_MODULE_CALLBACK_SAVE_AUTHENTICATION</primary></indexterm><programlisting>#define GNOME_VFS_MODULE_CALLBACK_SAVE_AUTHENTICATION "save-authentication"

523

<indexterm zone="GNOME-VFS-MODULE-CALLBACK-SAVE-AUTHENTICATION:CAPS"><primary>GNOME_VFS_MODULE_CALLBACK_SAVE_AUTHENTICATION</primary></indexterm>

524

<programlisting>#define GNOME_VFS_MODULE_CALLBACK_SAVE_AUTHENTICATION "save-authentication"

515

525

</programlisting>

516

526

<para>

517

527

A module callback name used together with <link linkend="gnome-vfs-module-callback-invoke"><function>gnome_vfs_module_callback_invoke()</function></link> to

522

532

Called after a successfull authentication, to allow the client to e.g.

523

533

store the password for future use. It may be queried again within the

524

534

current session (temporary storage) or in future sessions (permanent

525

storage) using <link linkend="GNOME-VFS-MODULE-CALLBACK-FILL-AUTHENTICATION--CAPS"><type>GNOME_VFS_MODULE_CALLBACK_FILL_AUTHENTICATION</type></link>.

535

storage) using <link linkend="GNOME-VFS-MODULE-CALLBACK-FILL-AUTHENTICATION.:CAPS"><type>GNOME_VFS_MODULE_CALLBACK_FILL_AUTHENTICATION.</type></link>

526

536

</para>

527

537

<para>

528

538

This is typically called after the user provided login data with

529

539

530

540

</para>

531

541

<para>

532

542

549

559

</para></refsect2>

550

560

551

561

<title>GnomeVFSModuleCallbackSaveAuthenticationIn</title>

552

<indexterm zone="GnomeVFSModuleCallbackSaveAuthenticationIn"><primary sortas="GnomeVFSModuleCallbackSaveAuthenticationIn">GnomeVFSModuleCallbackSaveAuthenticationIn</primary></indexterm><programlisting>typedef struct {

562

<indexterm zone="GnomeVFSModuleCallbackSaveAuthenticationIn"><primary>GnomeVFSModuleCallbackSaveAuthenticationIn</primary></indexterm>

563

<programlisting>typedef struct {

553

564

char *keyring;

554

565

555

566

char *uri;

565

576

</programlisting>

566

577

<para>

567

578

A <link linkend="GnomeVFSModuleCallbackSaveAuthenticatioIn"><type>GnomeVFSModuleCallbackSaveAuthenticatioIn</type></link> pointer is passed to a

568

579

569

580

and specifies the login data that should be stored permanently on

570

581

disk or temporarily cached.

571

582

</para>

572

583

<para>

573

584

This data may be queried in future sessions (permanent storage) or within

574

585

the current session (temporary storage) using

575

586

576

587

<para>

577

588

</para><variablelist role="struct">

578

589

579

<term><link linkend="char">char</link> *<structfield>keyring</structfield>;</term>

580

<listitem><simpara> Keyring provided by <link linkend="GNOME-VFS-MODULE-CALLBACK-FULL-AUTHENTICATION--CAPS"><type>GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION</type></link> callback.

590

<term><link linkend="char">char</link> *<structfield id="GnomeVFSModuleCallbackSaveAuthenticationIn.keyring">keyring</structfield>;</term>

591

<listitem><simpara> Keyring provided by <link linkend="GNOME-VFS-MODULE-CALLBACK-FULL-AUTHENTICATION:CAPS"><type>GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION</type></link> callback.

581

592

</simpara></listitem>

582

593

</varlistentry>

583

594

584

595

585

596

<listitem><simpara> The textual URI of the resource that is accessed.

586

597

</simpara></listitem>

587

598

</varlistentry>

588

599

589

<term><link linkend="char">char</link> *<structfield>protocol</structfield>;</term>

600

<term><link linkend="char">char</link> *<structfield id="GnomeVFSModuleCallbackSaveAuthenticationIn.protocol">protocol</structfield>;</term>

590

601

<listitem><simpara> One of the protocols supported by the invoking module.

591

602

Typically matches <parameter>uri</parameter>'s protocol.

592

603

</simpara></listitem>

593

604

</varlistentry>

594

605

595

<term><link linkend="char">char</link> *<structfield>server</structfield>;</term>

606

<term><link linkend="char">char</link> *<structfield id="GnomeVFSModuleCallbackSaveAuthenticationIn.server">server</structfield>;</term>

596

607

<listitem><simpara> The server that contains the resource that is accessed.

597

608

Typically matches <parameter>uri</parameter>'s hostname.

598

609

</simpara></listitem>

599

610

</varlistentry>

600

611

601

<term><link linkend="char">char</link> *<structfield>object</structfield>;</term>

612

<term><link linkend="char">char</link> *<structfield id="GnomeVFSModuleCallbackSaveAuthenticationIn.object">object</structfield>;</term>

602

613

<listitem><simpara> The type of the resource that is accessed.

603

614

</simpara></listitem>

604

615

</varlistentry>

605

616

606

617

607

618

<listitem><simpara> The port that was used to connect to <parameter>server</parameter>. 0 means unset.

608

619

</simpara></listitem>

609

620

</varlistentry>

610

621

611

<term><link linkend="char">char</link> *<structfield>authtype</structfield>;</term>

622

<term><link linkend="char">char</link> *<structfield id="GnomeVFSModuleCallbackSaveAuthenticationIn.authtype">authtype</structfield>;</term>

612

623

<listitem><simpara> The type of authentication that was requested. For the

613

624

HTTP method, this may be "basic" or "proxy". For the SFTP method,

614

625

this may be "publickey" or "password".

615

626

</simpara></listitem>

616

627

</varlistentry>

617

628

618

<term><link linkend="char">char</link> *<structfield>username</structfield>;</term>

629

<term><link linkend="char">char</link> *<structfield id="GnomeVFSModuleCallbackSaveAuthenticationIn.username">username</structfield>;</term>

619

630

<listitem><simpara> The username that was used to connect to <parameter>server</parameter>.

620

631

</simpara></listitem>

621

632

</varlistentry>

622

633

623

<term><link linkend="char">char</link> *<structfield>domain</structfield>;</term>

634

<term><link linkend="char">char</link> *<structfield id="GnomeVFSModuleCallbackSaveAuthenticationIn.domain">domain</structfield>;</term>

624

635

<listitem><simpara> The domain that <parameter>server</parameter> belongs to (only used by the SMB method).

625

636

</simpara></listitem>

626

637

</varlistentry>

627

638

628

<term><link linkend="char">char</link> *<structfield>password</structfield>;</term>

639

<term><link linkend="char">char</link> *<structfield id="GnomeVFSModuleCallbackSaveAuthenticationIn.password">password</structfield>;</term>

629

640

<listitem><simpara> The password that was used to connect to <parameter>server</parameter>.

630

641

</simpara></listitem>

631

642

</varlistentry>

632

643

</variablelist></refsect2>

633

644

634

645

<title>GnomeVFSModuleCallbackSaveAuthenticationOut</title>

635

<indexterm zone="GnomeVFSModuleCallbackSaveAuthenticationOut"><primary sortas="GnomeVFSModuleCallbackSaveAuthenticationOut">GnomeVFSModuleCallbackSaveAuthenticationOut</primary></indexterm><programlisting>typedef struct {

646

<indexterm zone="GnomeVFSModuleCallbackSaveAuthenticationOut"><primary>GnomeVFSModuleCallbackSaveAuthenticationOut</primary></indexterm>

647

<programlisting>typedef struct {

636

648

} GnomeVFSModuleCallbackSaveAuthenticationOut;

637

649

</programlisting>

638

650

<para>

639

651

A <link linkend="GnomeVFSModuleCallbackSaveAuthenticationOut"><type>GnomeVFSModuleCallbackSaveAuthenticationOut</type></link> pointer is passed to a

640

652

641

653

and is reserved for future use. Applications are not expected

642

654

to modify this data, because its interpretation might change

643

655

in the future.</para>

644

656

<para>

645

657

</para></refsect2>

646

658

647

659

<title>GNOME_VFS_MODULE_CALLBACK_QUESTION</title>

648

<indexterm zone="GNOME-VFS-MODULE-CALLBACK-QUESTION--CAPS"><primary sortas="GNOME_VFS_MODULE_CALLBACK_QUESTION">GNOME_VFS_MODULE_CALLBACK_QUESTION</primary></indexterm><programlisting>#define GNOME_VFS_MODULE_CALLBACK_QUESTION "ask-question"

660

<indexterm zone="GNOME-VFS-MODULE-CALLBACK-QUESTION:CAPS"><primary>GNOME_VFS_MODULE_CALLBACK_QUESTION</primary></indexterm>

661

<programlisting>#define GNOME_VFS_MODULE_CALLBACK_QUESTION "ask-question"

649

662

</programlisting>

650

663

<para>

651

664

A module callback name used together with <link linkend="gnome-vfs-module-callback-invoke"><function>gnome_vfs_module_callback_invoke()</function></link> to

677

690

</para></refsect2>

678

691

679

692

<title>GnomeVFSModuleCallbackQuestionIn</title>

680

<indexterm zone="GnomeVFSModuleCallbackQuestionIn"><primary sortas="GnomeVFSModuleCallbackQuestionIn">GnomeVFSModuleCallbackQuestionIn</primary></indexterm><programlisting>typedef struct {

693

<indexterm zone="GnomeVFSModuleCallbackQuestionIn"><primary>GnomeVFSModuleCallbackQuestionIn</primary></indexterm>

694

<programlisting>typedef struct {

681

695

char *primary_message;

682

696

char *secondary_message;

683

697

char **choices;

685

699

</programlisting>

686

700

<para>

687

701

A <link linkend="GnomeVFSModuleCallbackQuestionIn"><type>GnomeVFSModuleCallbackQuestionIn</type></link> pointer is passed to a

688

702

689

703

Applications are expected to request a decision from the

690

704

user, and store the answer in a <link linkend="GnomeVFSModuleCallbackQuestionOut"><type>GnomeVFSModuleCallbackQuestionOut</type></link>

691

705

structure.</para>

692

706

<para>

693

707

</para><variablelist role="struct">

694

708

695

<term><link linkend="char">char</link> *<structfield>primary_message</structfield>;</term>

709

<term><link linkend="char">char</link> *<structfield id="GnomeVFSModuleCallbackQuestionIn.primary_message">primary_message</structfield>;</term>

696

710

<listitem><simpara> A short message explaining the question to the user,

697

or <link linkend="NULL--CAPS"><literal>NULL</literal></link> if there is no message.

711

or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if there is no message.

698

712

</simpara></listitem>

699

713

</varlistentry>

700

714

701

<term><link linkend="char">char</link> *<structfield>secondary_message</structfield>;</term>

715

<term><link linkend="char">char</link> *<structfield id="GnomeVFSModuleCallbackQuestionIn.secondary_message">secondary_message</structfield>;</term>

702

716

<listitem><simpara> The long version of the message, containing more

703

details, or <link linkend="NULL--CAPS"><literal>NULL</literal></link> if there is no message.

717

details, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if there is no message.

704

718

</simpara></listitem>

705

719

</varlistentry>

706

720

707

<term><link linkend="char">char</link> **<structfield>choices</structfield>;</term>

708

<listitem><simpara> <link linkend="NULL--CAPS"><literal>NULL</literal></link>-terminated string list of choices the user has to choose from.

721

<term><link linkend="char">char</link> **<structfield id="GnomeVFSModuleCallbackQuestionIn.choices">choices</structfield>;</term>

722

<listitem><simpara> <link linkend="NULL:CAPS"><literal>NULL</literal></link>-terminated string list of choices the user has to choose from.

709

723

The first item in the list should be affermative, and will be put on the right

710

724

in a GUI dialog.

711

725

</simpara></listitem>

713

727

</variablelist></refsect2>

714

728

715

729

<title>GnomeVFSModuleCallbackQuestionOut</title>

716

<indexterm zone="GnomeVFSModuleCallbackQuestionOut"><primary sortas="GnomeVFSModuleCallbackQuestionOut">GnomeVFSModuleCallbackQuestionOut</primary></indexterm><programlisting>typedef struct {

730

<indexterm zone="GnomeVFSModuleCallbackQuestionOut"><primary>GnomeVFSModuleCallbackQuestionOut</primary></indexterm>

731

<programlisting>typedef struct {

717

732

int answer;

718

733

} GnomeVFSModuleCallbackQuestionOut;

719

734

</programlisting>

720

735

<para>

721

736

A <link linkend="GnomeVFSModuleCallbackQuestionOut"><type>GnomeVFSModuleCallbackQuestionOut</type></link> pointer is passed to a

722

737

723

738

is used by applications to store the user's decision.</para>

724

739

<para>

725

740

</para><variablelist role="struct">

726

741

727

<term><link linkend="int">int</link> <structfield>answer</structfield>;</term>

742

<term><link linkend="int">int</link> <structfield id="GnomeVFSModuleCallbackQuestionOut.answer">answer</structfield>;</term>

728

743

<listitem><simpara> The index of the answer the user picked. Matches the base

729

744

pointer address of the user's choice in <link linkend="GnomeVFSModuleCallbackQuestionIn"><type>GnomeVFSModuleCallbackQuestionIn</type></link>,

730

i.e. its index in choices, where the first choice has index <link linkend="0--CAPS"><literal>0</literal></link>.

745

i.e. its index in choices, where the first choice has index <link linkend="0:CAPS"><literal>0</literal></link>.

731

746

</simpara></listitem>

732

747

</varlistentry>

733

748

</variablelist></refsect2>

734

749

735

750

<title>GNOME_VFS_MODULE_CALLBACK_STATUS_MESSAGE</title>

736

<indexterm zone="GNOME-VFS-MODULE-CALLBACK-STATUS-MESSAGE--CAPS"><primary sortas="GNOME_VFS_MODULE_CALLBACK_STATUS_MESSAGE">GNOME_VFS_MODULE_CALLBACK_STATUS_MESSAGE</primary></indexterm><programlisting>#define GNOME_VFS_MODULE_CALLBACK_STATUS_MESSAGE "status-message"

751

<indexterm zone="GNOME-VFS-MODULE-CALLBACK-STATUS-MESSAGE:CAPS"><primary>GNOME_VFS_MODULE_CALLBACK_STATUS_MESSAGE</primary></indexterm>

752

<programlisting>#define GNOME_VFS_MODULE_CALLBACK_STATUS_MESSAGE "status-message"

737

753

</programlisting>

738

754

<para>

739

755

A module callback name used together with <link linkend="gnome-vfs-module-callback-invoke"><function>gnome_vfs_module_callback_invoke()</function></link> to

763

779

</para></refsect2>

764

780

765

781

<title>GnomeVFSModuleCallbackStatusMessageIn</title>

766

<indexterm zone="GnomeVFSModuleCallbackStatusMessageIn"><primary sortas="GnomeVFSModuleCallbackStatusMessageIn">GnomeVFSModuleCallbackStatusMessageIn</primary></indexterm><programlisting>typedef struct {

782

<indexterm zone="GnomeVFSModuleCallbackStatusMessageIn"><primary>GnomeVFSModuleCallbackStatusMessageIn</primary></indexterm>

783

<programlisting>typedef struct {

767

784

char *uri;

768

785

char *message;

769

786

int percentage;

771

788

</programlisting>

772

789

<para>

773

790

A <link linkend="GnomeVFSModuleCallbackStatusMessageIn"><type>GnomeVFSModuleCallbackStatusMessageIn</type></link> pointer is passed to a

774

791

775

792

to inform it about the progress and/or status of an ongoing operation.</para>

776

793

<para>

777

794

</para><variablelist role="struct">

778

795

779

796

780

797

<listitem><simpara> The textual URI the status message refers to.

781

798

</simpara></listitem>

782

799

</varlistentry>

783

800

784

<term><link linkend="char">char</link> *<structfield>message</structfield>;</term>

801

<term><link linkend="char">char</link> *<structfield id="GnomeVFSModuleCallbackStatusMessageIn.message">message</structfield>;</term>

785

802

<listitem><simpara> The message the application should display to the user,

786

indicating the current state, or it is <link linkend="NULL--CAPS"><literal>NULL</literal></link>.

803

indicating the current state, or it is <link linkend="NULL:CAPS"><literal>NULL</literal></link>.

787

804

</simpara></listitem>

788

805

</varlistentry>

789

806

790

<term><link linkend="int">int</link> <structfield>percentage</structfield>;</term>

807

<term><link linkend="int">int</link> <structfield id="GnomeVFSModuleCallbackStatusMessageIn.percentage">percentage</structfield>;</term>

791

808

<listitem><simpara> The percentage indicating the completeness of

792

809

a currently pending operation on <parameter>uri</parameter> (1-100), or -1 if there

793

810

is no progress percentage to report.

796

813

</variablelist></refsect2>

797

814

798

815

<title>GnomeVFSModuleCallbackStatusMessageOut</title>

799

<indexterm zone="GnomeVFSModuleCallbackStatusMessageOut"><primary sortas="GnomeVFSModuleCallbackStatusMessageOut">GnomeVFSModuleCallbackStatusMessageOut</primary></indexterm><programlisting>typedef struct {

816

<indexterm zone="GnomeVFSModuleCallbackStatusMessageOut"><primary>GnomeVFSModuleCallbackStatusMessageOut</primary></indexterm>

817

<programlisting>typedef struct {

800

818

/* empty structs not allowed */

801

819

int dummy;

802

820

} GnomeVFSModuleCallbackStatusMessageOut;

803

821

</programlisting>

804

822

<para>

805

823

A <link linkend="GnomeVFSModuleCallbackStatusMessageOut"><type>GnomeVFSModuleCallbackStatusMessageOut</type></link> pointer is passed to a

806

824

807

825

and is reserved for future use. Applications are not expected

808

826

to modify this data, because its interpretation might change

809

827

in the future.</para>

810

828

<para>

811

829

</para><variablelist role="struct">

812

830

813

<term><link linkend="int">int</link> <structfield>dummy</structfield>;</term>

831

<term><link linkend="int">int</link> <structfield id="GnomeVFSModuleCallbackStatusMessageOut.dummy">dummy</structfield>;</term>

814

832

<listitem><simpara> unused.

815

833

</simpara></listitem>

816

834

</varlistentry>

817

835

</variablelist></refsect2>

818

836

819

837

<title>GNOME_VFS_MODULE_CALLBACK_HTTP_SEND_ADDITIONAL_HEADERS</title>

820

<indexterm zone="GNOME-VFS-MODULE-CALLBACK-HTTP-SEND-ADDITIONAL-HEADERS--CAPS"><primary sortas="GNOME_VFS_MODULE_CALLBACK_HTTP_SEND_ADDITIONAL_HEADERS">GNOME_VFS_MODULE_CALLBACK_HTTP_SEND_ADDITIONAL_HEADERS</primary></indexterm><programlisting>#define GNOME_VFS_MODULE_CALLBACK_HTTP_SEND_ADDITIONAL_HEADERS "http:send-additional-headers"

838

<indexterm zone="GNOME-VFS-MODULE-CALLBACK-HTTP-SEND-ADDITIONAL-HEADERS:CAPS"><primary>GNOME_VFS_MODULE_CALLBACK_HTTP_SEND_ADDITIONAL_HEADERS</primary></indexterm>

839

<programlisting>#define GNOME_VFS_MODULE_CALLBACK_HTTP_SEND_ADDITIONAL_HEADERS "http:send-additional-headers"

821

840

</programlisting>

822

841

<para>

823

842

A module callback name used together with <link linkend="gnome-vfs-module-callback-invoke"><function>gnome_vfs_module_callback_invoke()</function></link> to

849

868

</para></refsect2>

850

869

851

870

<title>GnomeVFSModuleCallbackAdditionalHeadersIn</title>

852

<indexterm zone="GnomeVFSModuleCallbackAdditionalHeadersIn"><primary sortas="GnomeVFSModuleCallbackAdditionalHeadersIn">GnomeVFSModuleCallbackAdditionalHeadersIn</primary></indexterm><programlisting>typedef struct {

871

<indexterm zone="GnomeVFSModuleCallbackAdditionalHeadersIn"><primary>GnomeVFSModuleCallbackAdditionalHeadersIn</primary></indexterm>

872

<programlisting>typedef struct {

853

873

GnomeVFSURI *uri;

854

874

} GnomeVFSModuleCallbackAdditionalHeadersIn;

855

875

</programlisting>

856

876

<para>

857

877

A <link linkend="GnomeVFSModuleCallbackAdditionalHeadersIn"><type>GnomeVFSModuleCallbackAdditionalHeadersIn</type></link> pointer is passed to a

858

878

859

879

callback, to inform it about a pending HTTP request and allow it to

860

880

add additional headers.</para>

861

881

<para>

862

882

</para><variablelist role="struct">

863

883

864

<term><link linkend="GnomeVFSURI">GnomeVFSURI</link> *<structfield>uri</structfield>;</term>

884

<term><link linkend="GnomeVFSURI">GnomeVFSURI</link> *<structfield id="GnomeVFSModuleCallbackAdditionalHeadersIn.uri">uri</structfield>;</term>

865

885

<listitem><simpara> A <link linkend="GnomeVFSURI"><type>GnomeVFSURI</type></link> identifying the resource of the currently pending request.

866

886

</simpara></listitem>

867

887

</varlistentry>

868

888

</variablelist></refsect2>

869

889

870

890

<title>GnomeVFSModuleCallbackAdditionalHeadersOut</title>

871

<indexterm zone="GnomeVFSModuleCallbackAdditionalHeadersOut"><primary sortas="GnomeVFSModuleCallbackAdditionalHeadersOut">GnomeVFSModuleCallbackAdditionalHeadersOut</primary></indexterm><programlisting>typedef struct {

891

<indexterm zone="GnomeVFSModuleCallbackAdditionalHeadersOut"><primary>GnomeVFSModuleCallbackAdditionalHeadersOut</primary></indexterm>

892

<programlisting>typedef struct {

872

893

GList *headers;

873

894

} GnomeVFSModuleCallbackAdditionalHeadersOut;

874

895

</programlisting>

875

896

<para>

876

897

A <link linkend="GnomeVFSModuleCallbackAdditionalHeadersOut"><type>GnomeVFSModuleCallbackAdditionalHeadersOut</type></link> pointer is passed to a

877

898

878

899

callback, to store the headers the application wants to add to

879

900

a pending HTTP request.</para>

880

901

<para>

881

902

</para><variablelist role="struct">

882

903

883

<term><link linkend="GList">GList</link> *<structfield>headers</structfield>;</term>

904

<term><link linkend="GList">GList</link> *<structfield id="GnomeVFSModuleCallbackAdditionalHeadersOut.headers">headers</structfield>;</term>

884

905

<listitem><simpara> A <link linkend="GList"><type>GList</type></link> of strings, each of them is an additional header that

885

906

is added to the HTTP request. <parameter>headers</parameter> and all its strings will be freed

886

907

by the module when they aren't needed any longer.

887

908

</simpara></listitem>

888

909

</varlistentry>

889

910

</variablelist></refsect2>

890

911

891

912

<title>GNOME_VFS_MODULE_CALLBACK_HTTP_RECEIVED_HEADERS</title>

892

<indexterm zone="GNOME-VFS-MODULE-CALLBACK-HTTP-RECEIVED-HEADERS--CAPS"><primary sortas="GNOME_VFS_MODULE_CALLBACK_HTTP_RECEIVED_HEADERS">GNOME_VFS_MODULE_CALLBACK_HTTP_RECEIVED_HEADERS</primary></indexterm><programlisting>#define GNOME_VFS_MODULE_CALLBACK_HTTP_RECEIVED_HEADERS "http:received-headers"

913

<indexterm zone="GNOME-VFS-MODULE-CALLBACK-HTTP-RECEIVED-HEADERS:CAPS"><primary>GNOME_VFS_MODULE_CALLBACK_HTTP_RECEIVED_HEADERS</primary></indexterm>

914

<programlisting>#define GNOME_VFS_MODULE_CALLBACK_HTTP_RECEIVED_HEADERS "http:received-headers"

893

915

</programlisting>

894

916

<para>

895

917

A module callback name used together with <link linkend="gnome-vfs-module-callback-invoke"><function>gnome_vfs_module_callback_invoke()</function></link> to

896

918

inform an application about the delivery of a HTTP request.

897

919

</para>

898

920

<para>

899

921

900

922

receiving HTTP headers from a server that belonged to a HTTP

901

923

request that was issued by the application and allows the

902

924

application to analyze the returned headers.

922

944

</para></refsect2>

923

945

924

946

<title>GnomeVFSModuleCallbackReceivedHeadersIn</title>

925

<indexterm zone="GnomeVFSModuleCallbackReceivedHeadersIn"><primary sortas="GnomeVFSModuleCallbackReceivedHeadersIn">GnomeVFSModuleCallbackReceivedHeadersIn</primary></indexterm><programlisting>typedef struct {

947

<indexterm zone="GnomeVFSModuleCallbackReceivedHeadersIn"><primary>GnomeVFSModuleCallbackReceivedHeadersIn</primary></indexterm>

948

<programlisting>typedef struct {

926

949

GnomeVFSURI *uri;

927

950

GList *headers;

928

951

} GnomeVFSModuleCallbackReceivedHeadersIn;

929

952

</programlisting>

930

953

<para>

931

954

A <link linkend="GnomeVFSModuleCallbackReceivedHeadersIn"><type>GnomeVFSModuleCallbackReceivedHeadersIn</type></link> pointer is passed to a

932

955

933

956

callback, to inform it about a delivered HTTP request and allow

934

957

it to analyze the returned headers.</para>

935

958

<para>

936

959

</para><variablelist role="struct">

937

960

938

<term><link linkend="GnomeVFSURI">GnomeVFSURI</link> *<structfield>uri</structfield>;</term>

961

<term><link linkend="GnomeVFSURI">GnomeVFSURI</link> *<structfield id="GnomeVFSModuleCallbackReceivedHeadersIn.uri">uri</structfield>;</term>

939

962

<listitem><simpara> A <link linkend="GnomeVFSURI"><type>GnomeVFSURI</type></link> identifying the resource of the currently delivered request.

940

963

</simpara></listitem>

941

964

</varlistentry>

942

965

943

<term><link linkend="GList">GList</link> *<structfield>headers</structfield>;</term>

966

<term><link linkend="GList">GList</link> *<structfield id="GnomeVFSModuleCallbackReceivedHeadersIn.headers">headers</structfield>;</term>

944

967

<listitem><simpara> A <link linkend="GList"><type>GList</type></link> of strings, each of them is a header that was received when

945

968

delivering the HTTP request. <parameter>headers</parameter> and all its strings will be freed

946

969

by the module when they aren't needed any longer.

949

972

</variablelist></refsect2>

950

973

951

974

<title>GnomeVFSModuleCallbackReceivedHeadersOut</title>

952

<indexterm zone="GnomeVFSModuleCallbackReceivedHeadersOut"><primary sortas="GnomeVFSModuleCallbackReceivedHeadersOut">GnomeVFSModuleCallbackReceivedHeadersOut</primary></indexterm><programlisting>typedef struct {

975

<indexterm zone="GnomeVFSModuleCallbackReceivedHeadersOut"><primary>GnomeVFSModuleCallbackReceivedHeadersOut</primary></indexterm>

976

<programlisting>typedef struct {

953

977

int dummy;

954

978

} GnomeVFSModuleCallbackReceivedHeadersOut;

955

979

</programlisting>

956

980

<para>

957

981

A <link linkend="GnomeVFSModuleCallbackReceivedHeadersOut"><type>GnomeVFSModuleCallbackReceivedHeadersOut</type></link> pointer is passed to a

958

982

959

983

callback, and is reserved for future use. Applications are not

960

984

expected to modify this data, because its interpretation might

961

985

change in the future.</para>

962

986

<para>

963

987

</para><variablelist role="struct">

964

988

965

<term><link linkend="int">int</link> <structfield>dummy</structfield>;</term>

989

<term><link linkend="int">int</link> <structfield id="GnomeVFSModuleCallbackReceivedHeadersOut.dummy">dummy</structfield>;</term>

966

990

<listitem><simpara> unused.

967

991

</simpara></listitem>

968

992

</varlistentry>

969

993

</variablelist></refsect2>

970

994

971

995

<title>GNOME_VFS_MODULE_CALLBACK_AUTHENTICATION</title>

972

<indexterm zone="GNOME-VFS-MODULE-CALLBACK-AUTHENTICATION--CAPS" role="deprecated"><primary sortas="GNOME_VFS_MODULE_CALLBACK_AUTHENTICATION">GNOME_VFS_MODULE_CALLBACK_AUTHENTICATION</primary></indexterm><programlisting>#define GNOME_VFS_MODULE_CALLBACK_AUTHENTICATION "simple-authentication"

996

<indexterm zone="GNOME-VFS-MODULE-CALLBACK-AUTHENTICATION:CAPS" role="deprecated"><primary>GNOME_VFS_MODULE_CALLBACK_AUTHENTICATION</primary></indexterm>

997

<programlisting>#define GNOME_VFS_MODULE_CALLBACK_AUTHENTICATION "simple-authentication"

973

998

</programlisting>

974

<warning><para><literal>GNOME_VFS_MODULE_CALLBACK_AUTHENTICATION</literal> is deprecated and should not be used in newly-written code. Modules should use <link linkend="GNOME-VFS-MODULE-CALLBACK-FILL-AUTHENTICATION--CAPS"><type>GNOME_VFS_MODULE_CALLBACK_FILL_AUTHENTICATION</type></link>

975

and <link linkend="GNOME-VFS-MODULE-CALLBACK-FULL-AUTHENTICATION--CAPS"><type>GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION</type></link>.</para></warning>

999

<warning><para><literal>GNOME_VFS_MODULE_CALLBACK_AUTHENTICATION</literal> is deprecated and should not be used in newly-written code. Modules should use <link linkend="GNOME-VFS-MODULE-CALLBACK-FILL-AUTHENTICATION:CAPS"><type>GNOME_VFS_MODULE_CALLBACK_FILL_AUTHENTICATION</type></link>

1000

and <link linkend="GNOME-VFS-MODULE-CALLBACK-FULL-AUTHENTICATION.:CAPS"><type>GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION.</type></link></para></warning>

976

1001

<para>

977

1002

A module callback name formerly used together with <link linkend="gnome-vfs-module-callback-invoke"><function>gnome_vfs_module_callback_invoke()</function></link>.

978

1003

</para>

998

1023

</variablelist></para>

999

1024

<para>

1000

1025

</para></refsect2>

1001

1026

1002

1027

<title>GNOME_VFS_MODULE_CALLBACK_HTTP_PROXY_AUTHENTICATION</title>

1003

<indexterm zone="GNOME-VFS-MODULE-CALLBACK-HTTP-PROXY-AUTHENTICATION--CAPS" role="deprecated"><primary sortas="GNOME_VFS_MODULE_CALLBACK_HTTP_PROXY_AUTHENTICATION">GNOME_VFS_MODULE_CALLBACK_HTTP_PROXY_AUTHENTICATION</primary></indexterm><programlisting>#define GNOME_VFS_MODULE_CALLBACK_HTTP_PROXY_AUTHENTICATION "http:proxy-authentication"

1028

<indexterm zone="GNOME-VFS-MODULE-CALLBACK-HTTP-PROXY-AUTHENTICATION:CAPS" role="deprecated"><primary>GNOME_VFS_MODULE_CALLBACK_HTTP_PROXY_AUTHENTICATION</primary></indexterm>

1029

<programlisting>#define GNOME_VFS_MODULE_CALLBACK_HTTP_PROXY_AUTHENTICATION "http:proxy-authentication"

1004

1030

</programlisting>

1005

1031

<warning><para><literal>GNOME_VFS_MODULE_CALLBACK_HTTP_PROXY_AUTHENTICATION</literal> is deprecated and should not be used in newly-written code. Proxy authentication now works desktop-wide through GConf.</para></warning>

1006

1032

<para>

1007

1033

A module callback name formerly used together with <link linkend="gnome-vfs-module-callback-invoke"><function>gnome_vfs_module_callback_invoke()</function></link>

1008

1034

to ask the user for HTTP proxy login data. It works exactly like

1009

1035

1010

1036

allow applications to distinguish proxy authentication from actual server

1011

1037

authentication, so that the wording of the interface could be adapted.

1012

1038

</para>

1034

1060

</para></refsect2>

1035

1061

1036

1062

<title>enum GnomeVFSModuleCallbackAuthenticationAuthType</title>

1037

<indexterm zone="GnomeVFSModuleCallbackAuthenticationAuthType" role="deprecated"><primary sortas="GnomeVFSModuleCallbackAuthenticationAuthType">GnomeVFSModuleCallbackAuthenticationAuthType</primary></indexterm><programlisting>typedef enum {

1063

<indexterm zone="GnomeVFSModuleCallbackAuthenticationAuthType" role="deprecated"><primary>GnomeVFSModuleCallbackAuthenticationAuthType</primary></indexterm>

1064

<programlisting>typedef enum {

1038

1065

AuthTypeBasic,

1039

1066

AuthTypeDigest

1040

1067

} GnomeVFSModuleCallbackAuthenticationAuthType;

1041

1068

</programlisting>

1042

<warning><para><literal>GnomeVFSModuleCallbackAuthenticationAuthType</literal> is deprecated and should not be used in newly-written code. Modules should use <link linkend="GNOME-VFS-MODULE-CALLBACK-FILL-AUTHENTICATION--CAPS"><type>GNOME_VFS_MODULE_CALLBACK_FILL_AUTHENTICATION</type></link>

1043

and <link linkend="GNOME-VFS-MODULE-CALLBACK-FULL-AUTHENTICATION--CAPS"><type>GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION</type></link>.</para></warning>

1069

<warning><para><literal>GnomeVFSModuleCallbackAuthenticationAuthType</literal> is deprecated and should not be used in newly-written code. Modules should use <link linkend="GNOME-VFS-MODULE-CALLBACK-FILL-AUTHENTICATION:CAPS"><type>GNOME_VFS_MODULE_CALLBACK_FILL_AUTHENTICATION</type></link>

1070

and <link linkend="GNOME-VFS-MODULE-CALLBACK-FULL-AUTHENTICATION.:CAPS"><type>GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION.</type></link></para></warning>

1044

1071

<para>

1045

1072

This defines the possible values of the <link linkend="GnomeVFSModuleCallbackAuthenticationIn"><type>GnomeVFSModuleCallbackAuthenticationIn</type></link>'s

1046

1073

1059

1086

</variablelist></refsect2>

1060

1087

1061

1088

<title>GnomeVFSModuleCallbackAuthenticationIn</title>

1062

<indexterm zone="GnomeVFSModuleCallbackAuthenticationIn" role="deprecated"><primary sortas="GnomeVFSModuleCallbackAuthenticationIn">GnomeVFSModuleCallbackAuthenticationIn</primary></indexterm><programlisting>typedef struct {

1089

<indexterm zone="GnomeVFSModuleCallbackAuthenticationIn" role="deprecated"><primary>GnomeVFSModuleCallbackAuthenticationIn</primary></indexterm>

1090

<programlisting>typedef struct {

1063

1091

char *uri;

1064

1092

char *realm;

1065

1093

gboolean previous_attempt_failed;

1066

1094

GnomeVFSModuleCallbackAuthenticationAuthType auth_type;

1067

1095

} GnomeVFSModuleCallbackAuthenticationIn;

1068

1096

</programlisting>

1069

<warning><para><literal>GnomeVFSModuleCallbackAuthenticationIn</literal> is deprecated and should not be used in newly-written code. Modules should use <link linkend="GNOME-VFS-MODULE-CALLBACK-FILL-AUTHENTICATION--CAPS"><type>GNOME_VFS_MODULE_CALLBACK_FILL_AUTHENTICATION</type></link>

1070

and <link linkend="GNOME-VFS-MODULE-CALLBACK-FULL-AUTHENTICATION--CAPS"><type>GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION</type></link>.</para></warning>

1097

<warning><para><literal>GnomeVFSModuleCallbackAuthenticationIn</literal> is deprecated and should not be used in newly-written code. Modules should use <link linkend="GNOME-VFS-MODULE-CALLBACK-FILL-AUTHENTICATION:CAPS"><type>GNOME_VFS_MODULE_CALLBACK_FILL_AUTHENTICATION</type></link>

1098

and <link linkend="GNOME-VFS-MODULE-CALLBACK-FULL-AUTHENTICATION.:CAPS"><type>GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION.</type></link></para></warning>

1071

1099

<para>

1072

1100

A pointer to a <link linkend="GnomeVFSModuleCallbackAuthenticationIn"><type>GnomeVFSModuleCallbackAuthenticationIn</type></link> structure that used to be

1073

passed to the <link linkend="GNOME-VFS-MODULE-CALLBACK-AUTHENTICATION--CAPS"><type>GNOME_VFS_MODULE_CALLBACK_AUTHENTICATION</type></link> callback, and informed

1101

passed to the <link linkend="GNOME-VFS-MODULE-CALLBACK-AUTHENTICATION:CAPS"><type>GNOME_VFS_MODULE_CALLBACK_AUTHENTICATION</type></link> callback, and informed

1074

1102

the application about the authentication parameters that should be requested.</para>

1075

1103

<para>

1076

1104

</para><variablelist role="struct">

1077

1105

1078

1106

1079

1107

<listitem><simpara> The textual URI of the resource that requires authentication.

1080

1108

</simpara></listitem>

1081

1109

</varlistentry>

1082

1110

1083

<term><link linkend="char">char</link> *<structfield>realm</structfield>;</term>

1084

<listitem><simpara> "auth" for HTTP, <link linkend="NULL--CAPS"><literal>NULL</literal></link> for others.

1111

<term><link linkend="char">char</link> *<structfield id="GnomeVFSModuleCallbackAuthenticationIn.realm">realm</structfield>;</term>

1112

<listitem><simpara> "auth" for HTTP, <link linkend="NULL:CAPS"><literal>NULL</literal></link> for others.

1085

1113

</simpara></listitem>

1086

1114

</varlistentry>

1087

1115

1088

<term><link linkend="gboolean">gboolean</link> <structfield>previous_attempt_failed</structfield>;</term>

1089

<listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if there already was login data

1090

specified for this request, but the login failed. <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> if no

1116

<term><link linkend="gboolean">gboolean</link> <structfield id="GnomeVFSModuleCallbackAuthenticationIn.previous_attempt_failed">previous_attempt_failed</structfield>;</term>

1117

<listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if there already was login data

1118

specified for this request, but the login failed. <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> if no

1091

1119

previous login attempt has been made right before this one.

1092

1120

</simpara></listitem>

1093

1121

</varlistentry>

1094

1122

1095

<term><link linkend="GnomeVFSModuleCallbackAuthenticationAuthType">GnomeVFSModuleCallbackAuthenticationAuthType</link> <structfield>auth_type</structfield>;</term>

1123

<term><link linkend="GnomeVFSModuleCallbackAuthenticationAuthType">GnomeVFSModuleCallbackAuthenticationAuthType</link> <structfield id="GnomeVFSModuleCallbackAuthenticationIn.auth_type">auth_type</structfield>;</term>

1096

1124

<listitem><simpara> Whether the login data will be transmitted in plaintext or encrypted.

1097

1125

</simpara></listitem>

1098

1126

</varlistentry>

1099

1127

</variablelist></refsect2>

1100

1128

1101

1129

<title>GnomeVFSModuleCallbackAuthenticationOut</title>

1102

<indexterm zone="GnomeVFSModuleCallbackAuthenticationOut" role="deprecated"><primary sortas="GnomeVFSModuleCallbackAuthenticationOut">GnomeVFSModuleCallbackAuthenticationOut</primary></indexterm><programlisting>typedef struct {

1130

<indexterm zone="GnomeVFSModuleCallbackAuthenticationOut" role="deprecated"><primary>GnomeVFSModuleCallbackAuthenticationOut</primary></indexterm>

1131

<programlisting>typedef struct {

1103

1132

char *username;

1104

1133

char *password;

1105

1134

} GnomeVFSModuleCallbackAuthenticationOut;

1106

1135

</programlisting>

1107

<warning><para><literal>GnomeVFSModuleCallbackAuthenticationOut</literal> is deprecated and should not be used in newly-written code. Modules should use <link linkend="GNOME-VFS-MODULE-CALLBACK-FILL-AUTHENTICATION--CAPS"><type>GNOME_VFS_MODULE_CALLBACK_FILL_AUTHENTICATION</type></link>

1108

and <link linkend="GNOME-VFS-MODULE-CALLBACK-FULL-AUTHENTICATION--CAPS"><type>GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION</type></link>.</para></warning>

1136

<warning><para><literal>GnomeVFSModuleCallbackAuthenticationOut</literal> is deprecated and should not be used in newly-written code. Modules should use <link linkend="GNOME-VFS-MODULE-CALLBACK-FILL-AUTHENTICATION:CAPS"><type>GNOME_VFS_MODULE_CALLBACK_FILL_AUTHENTICATION</type></link>

1137

and <link linkend="GNOME-VFS-MODULE-CALLBACK-FULL-AUTHENTICATION.:CAPS"><type>GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION.</type></link></para></warning>

1109

1138

<para>

1110

1139

A pointer to a <link linkend="GnomeVFSModuleCallbackAuthenticationOut"><type>GnomeVFSModuleCallbackAuthenticationOut</type></link> structure that used to be

1111

passed to the <link linkend="GNOME-VFS-MODULE-CALLBACK-AUTHENTICATION--CAPS"><type>GNOME_VFS_MODULE_CALLBACK_AUTHENTICATION</type></link> callback, and was

1140

passed to the <link linkend="GNOME-VFS-MODULE-CALLBACK-AUTHENTICATION:CAPS"><type>GNOME_VFS_MODULE_CALLBACK_AUTHENTICATION</type></link> callback, and was

1112

1141

used to pass the login data back to the module.</para>

1113

1142

<para>

1114

1143

</para><variablelist role="struct">

1115

1144

1116

<term><link linkend="char">char</link> *<structfield>username</structfield>;</term>

1145

<term><link linkend="char">char</link> *<structfield id="GnomeVFSModuleCallbackAuthenticationOut.username">username</structfield>;</term>

1117

1146

<listitem><simpara> The username that should be used to access the resource

1118

referenced by <link linkend="GnomeVFSModuleCallbackFullAuthenticationIn"><type>GnomeVFSModuleCallbackFullAuthenticationIn</type></link>, or <link linkend="NULL--CAPS"><literal>NULL</literal></link>

1147

referenced by <link linkend="GnomeVFSModuleCallbackFullAuthenticationIn"><type>GnomeVFSModuleCallbackFullAuthenticationIn</type></link>, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>

1119

1148

if no data was provided. This will be freed by the module when it

1120

1149

isn't needed any longer.

1121

1150

</simpara></listitem>

1122

1151

</varlistentry>

1123

1152

1124

<term><link linkend="char">char</link> *<structfield>password</structfield>;</term>

1153

<term><link linkend="char">char</link> *<structfield id="GnomeVFSModuleCallbackAuthenticationOut.password">password</structfield>;</term>

1125

1154

<listitem><simpara> The password that should be used to access the resource

1126

referenced by <link linkend="GnomeVFSModuleCallbackFullAuthenticationIn"><type>GnomeVFSModuleCallbackFullAuthenticationIn</type></link>. This will

1155

referenced by <link linkend="GnomeVFSModuleCallbackFullAuthenticationIn."><type>GnomeVFSModuleCallbackFullAuthenticationIn.</type></link> This will

1127

1156

be freed by the module when it isn't needed any longer.

1128

1157

</simpara></listitem>

1129

1158

</varlistentry>

Older »