~ubuntu-branches/ubuntu/natty/gnome-vfs/natty : revision 17

1

1

2

3

<refentrytitle role="top_of_page" id="gnome-vfs-20-gnome-vfs-async-ops.top_of_page">Asynchronous File Operations</refentrytitle>

3

<refentrytitle role="top_of_page" id="gnome-vfs-2.0-gnome-vfs-async-ops.top_of_page">Asynchronous File Operations</refentrytitle>

4

5

<refmiscinfo>GNOME-VFS-2.0 Library</refmiscinfo>

6

</refmeta>

10

<refpurpose>POSIX-style file operations that run outside your main loop</refpurpose>

11

</refnamediv>

12

13

13

14

<title role="synopsis.title">Synopsis</title>

15

16

17

#define <link linkend="GNOME-VFS-PRIORITY-MIN--CAPS">GNOME_VFS_PRIORITY_MIN</link>

18

#define <link linkend="GNOME-VFS-PRIORITY-MAX--CAPS">GNOME_VFS_PRIORITY_MAX</link>

19

#define <link linkend="GNOME-VFS-PRIORITY-DEFAULT--CAPS">GNOME_VFS_PRIORITY_DEFAULT</link>

17

#define <link linkend="GNOME-VFS-PRIORITY-MIN:CAPS">GNOME_VFS_PRIORITY_MIN</link>

18

#define <link linkend="GNOME-VFS-PRIORITY-MAX:CAPS">GNOME_VFS_PRIORITY_MAX</link>

19

#define <link linkend="GNOME-VFS-PRIORITY-DEFAULT:CAPS">GNOME_VFS_PRIORITY_DEFAULT</link>

20

typedef <link linkend="GnomeVFSAsyncHandle">GnomeVFSAsyncHandle</link>;

21

22

239

240

241

242

242

243

<title role="desc.title">Description</title>

244

245

<para>

245

246

When executing an asynchornous operation on a file the program does not

246

247

block waiting for the operation to finish, instead it keeps on running,

262

263

</para>

263

264

</refsect1>

264

265

266

266

267

<title role="details.title">Details</title>

267

268

268

269

<title>GNOME_VFS_PRIORITY_MIN</title>

269

<indexterm zone="GNOME-VFS-PRIORITY-MIN--CAPS"><primary sortas="GNOME_VFS_PRIORITY_MIN">GNOME_VFS_PRIORITY_MIN</primary></indexterm><programlisting>#define GNOME_VFS_PRIORITY_MIN -10

270

<indexterm zone="GNOME-VFS-PRIORITY-MIN:CAPS"><primary>GNOME_VFS_PRIORITY_MIN</primary></indexterm>

271

<programlisting>#define GNOME_VFS_PRIORITY_MIN -10

270

272

</programlisting>

271

273

<para>

272

274

The minimuum priority a job can have.</para>

273

275

<para>

274

276

</para></refsect2>

275

277

276

278

<title>GNOME_VFS_PRIORITY_MAX</title>

277

<indexterm zone="GNOME-VFS-PRIORITY-MAX--CAPS"><primary sortas="GNOME_VFS_PRIORITY_MAX">GNOME_VFS_PRIORITY_MAX</primary></indexterm><programlisting>#define GNOME_VFS_PRIORITY_MAX 10

279

<indexterm zone="GNOME-VFS-PRIORITY-MAX:CAPS"><primary>GNOME_VFS_PRIORITY_MAX</primary></indexterm>

280

<programlisting>#define GNOME_VFS_PRIORITY_MAX 10

278

281

</programlisting>

279

282

<para>

280

283

The maximuum priority a job can have.</para>

281

284

<para>

282

285

</para></refsect2>

283

286

284

287

<title>GNOME_VFS_PRIORITY_DEFAULT</title>

285

<indexterm zone="GNOME-VFS-PRIORITY-DEFAULT--CAPS"><primary sortas="GNOME_VFS_PRIORITY_DEFAULT">GNOME_VFS_PRIORITY_DEFAULT</primary></indexterm><programlisting>#define GNOME_VFS_PRIORITY_DEFAULT 0

288

<indexterm zone="GNOME-VFS-PRIORITY-DEFAULT:CAPS"><primary>GNOME_VFS_PRIORITY_DEFAULT</primary></indexterm>

289

<programlisting>#define GNOME_VFS_PRIORITY_DEFAULT 0

286

290

</programlisting>

287

291

<para>

288

292

The default job priority. Its best to use this

291

295

</para></refsect2>

292

296

293

297

<title>GnomeVFSAsyncHandle</title>

294

<indexterm zone="GnomeVFSAsyncHandle"><primary sortas="GnomeVFSAsyncHandle">GnomeVFSAsyncHandle</primary></indexterm><programlisting>typedef struct GnomeVFSAsyncHandle GnomeVFSAsyncHandle;

298

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

299

<programlisting>typedef struct GnomeVFSAsyncHandle GnomeVFSAsyncHandle;

295

300

</programlisting>

296

301

<para>

297

302

</para></refsect2>

298

303

299

304

<title>GnomeVFSAsyncCallback ()</title>

300

<indexterm zone="GnomeVFSAsyncCallback"><primary sortas="GnomeVFSAsyncCallback">GnomeVFSAsyncCallback</primary></indexterm><programlisting><link linkend="void">void</link> (*GnomeVFSAsyncCallback) (<link linkend="GnomeVFSAsyncHandle">GnomeVFSAsyncHandle</link> *handle,

305

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

306

<programlisting><link linkend="void">void</link> (*GnomeVFSAsyncCallback) (<link linkend="GnomeVFSAsyncHandle">GnomeVFSAsyncHandle</link> *handle,

301

307

302

308

303

309

<para>

309

315

<listitem><simpara> handle of the operation generating the callback

310

316

</simpara></listitem></varlistentry>

311

317

<varlistentry><term><parameter>result</parameter> :</term>

312

<listitem><simpara> <link linkend="GNOME-VFS-OK--CAPS"><literal>GNOME_VFS_OK</literal></link> if the operation was successful, otherwise

318

<listitem><simpara> <link linkend="GNOME-VFS-OK:CAPS"><literal>GNOME_VFS_OK</literal></link> if the operation was successful, otherwise

313

319

an error code.

314

320

</simpara></listitem></varlistentry>

315

321

<varlistentry><term><parameter>callback_data</parameter> :</term>

318

324

</variablelist></refsect2>

319

325

320

326

<title>GnomeVFSAsyncOpenCallback ()</title>

321

<indexterm zone="GnomeVFSAsyncOpenCallback"><primary sortas="GnomeVFSAsyncOpenCallback">GnomeVFSAsyncOpenCallback</primary></indexterm><programlisting><link linkend="void">void</link> (*GnomeVFSAsyncOpenCallback) (<link linkend="GnomeVFSAsyncHandle">GnomeVFSAsyncHandle</link> *handle,

327

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

328

<programlisting><link linkend="void">void</link> (*GnomeVFSAsyncOpenCallback) (<link linkend="GnomeVFSAsyncHandle">GnomeVFSAsyncHandle</link> *handle,

322

329

323

330

324

331

<para>

330

337

<listitem><simpara> handle of the operation generating the callback

331

338

</simpara></listitem></varlistentry>

332

339

<varlistentry><term><parameter>result</parameter> :</term>

333

<listitem><simpara> <link linkend="GNOME-VFS-OK--CAPS"><literal>GNOME_VFS_OK</literal></link> if the operation was successful, otherwise

340

<listitem><simpara> <link linkend="GNOME-VFS-OK:CAPS"><literal>GNOME_VFS_OK</literal></link> if the operation was successful, otherwise

334

341

an error code.

335

342

</simpara></listitem></varlistentry>

336

343

<varlistentry><term><parameter>callback_data</parameter> :</term>

339

346

</variablelist></refsect2>

340

347

341

348

<title>GnomeVFSAsyncOpenAsChannelCallback ()</title>

342

<indexterm zone="GnomeVFSAsyncOpenAsChannelCallback" role="deprecated"><primary sortas="GnomeVFSAsyncOpenAsChannelCallback">GnomeVFSAsyncOpenAsChannelCallback</primary></indexterm><programlisting><link linkend="void">void</link> (*GnomeVFSAsyncOpenAsChannelCallback)

349

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

350

<programlisting><link linkend="void">void</link> (*GnomeVFSAsyncOpenAsChannelCallback)

343

351

(<link linkend="GnomeVFSAsyncHandle">GnomeVFSAsyncHandle</link> *handle,

344

352

345

353

357

365

<listitem><simpara> a <link linkend="GIOChannel"><type>GIOChannel</type></link> corresponding to the file opened

358

366

</simpara></listitem></varlistentry>

359

367

<varlistentry><term><parameter>result</parameter> :</term>

360

<listitem><simpara> <link linkend="GNOME-VFS-OK--CAPS"><literal>GNOME_VFS_OK</literal></link> if the operation was successful, otherwise

368

<listitem><simpara> <link linkend="GNOME-VFS-OK:CAPS"><literal>GNOME_VFS_OK</literal></link> if the operation was successful, otherwise

361

369

an error code.

362

370

</simpara></listitem></varlistentry>

363

371

<varlistentry><term><parameter>callback_data</parameter> :</term>

366

374

</variablelist></refsect2>

367

375

368

376

<title>GnomeVFSAsyncCreateCallback ()</title>

369

<indexterm zone="GnomeVFSAsyncCreateCallback"><primary sortas="GnomeVFSAsyncCreateCallback">GnomeVFSAsyncCreateCallback</primary></indexterm><programlisting><link linkend="void">void</link> (*GnomeVFSAsyncCreateCallback) (<link linkend="GnomeVFSAsyncHandle">GnomeVFSAsyncHandle</link> *handle,

377

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

378

<programlisting><link linkend="void">void</link> (*GnomeVFSAsyncCreateCallback) (<link linkend="GnomeVFSAsyncHandle">GnomeVFSAsyncHandle</link> *handle,

370

379

371

380

372

381

<para>

378

387

<listitem><simpara> handle of the operation generating the callback

379

388

</simpara></listitem></varlistentry>

380

389

<varlistentry><term><parameter>result</parameter> :</term>

381

<listitem><simpara> <link linkend="GNOME-VFS-OK--CAPS"><literal>GNOME_VFS_OK</literal></link> if the operation was successful, otherwise

390

<listitem><simpara> <link linkend="GNOME-VFS-OK:CAPS"><literal>GNOME_VFS_OK</literal></link> if the operation was successful, otherwise

382

391

an error code.

383

392

</simpara></listitem></varlistentry>

384

393

<varlistentry><term><parameter>callback_data</parameter> :</term>

387

396

</variablelist></refsect2>

388

397

389

398

<title>GnomeVFSAsyncCreateAsChannelCallback ()</title>

390

<indexterm zone="GnomeVFSAsyncCreateAsChannelCallback" role="deprecated"><primary sortas="GnomeVFSAsyncCreateAsChannelCallback">GnomeVFSAsyncCreateAsChannelCallback</primary></indexterm><programlisting><link linkend="void">void</link> (*GnomeVFSAsyncCreateAsChannelCallback)

399

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

400

<programlisting><link linkend="void">void</link> (*GnomeVFSAsyncCreateAsChannelCallback)

391

401

(<link linkend="GnomeVFSAsyncHandle">GnomeVFSAsyncHandle</link> *handle,

392

402

393

403

405

415

<listitem><simpara> a <link linkend="GIOChannel"><type>GIOChannel</type></link> corresponding to the file created

406

416

</simpara></listitem></varlistentry>

407

417

<varlistentry><term><parameter>result</parameter> :</term>

408

<listitem><simpara> <link linkend="GNOME-VFS-OK--CAPS"><literal>GNOME_VFS_OK</literal></link> if the operation was successful, otherwise

418

<listitem><simpara> <link linkend="GNOME-VFS-OK:CAPS"><literal>GNOME_VFS_OK</literal></link> if the operation was successful, otherwise

409

419

an error code.

410

420

</simpara></listitem></varlistentry>

411

421

<varlistentry><term><parameter>callback_data</parameter> :</term>

414

424

</variablelist></refsect2>

415

425

416

426

<title>GnomeVFSAsyncCloseCallback ()</title>

417

<indexterm zone="GnomeVFSAsyncCloseCallback"><primary sortas="GnomeVFSAsyncCloseCallback">GnomeVFSAsyncCloseCallback</primary></indexterm><programlisting><link linkend="void">void</link> (*GnomeVFSAsyncCloseCallback) (<link linkend="GnomeVFSAsyncHandle">GnomeVFSAsyncHandle</link> *handle,

427

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

428

<programlisting><link linkend="void">void</link> (*GnomeVFSAsyncCloseCallback) (<link linkend="GnomeVFSAsyncHandle">GnomeVFSAsyncHandle</link> *handle,

418

429

419

430

420

431

<para>

426

437

<listitem><simpara> handle of the operation generating the callback

427

438

</simpara></listitem></varlistentry>

428

439

<varlistentry><term><parameter>result</parameter> :</term>

429

<listitem><simpara> <link linkend="GNOME-VFS-OK--CAPS"><literal>GNOME_VFS_OK</literal></link> if the operation was successful, otherwise

440

<listitem><simpara> <link linkend="GNOME-VFS-OK:CAPS"><literal>GNOME_VFS_OK</literal></link> if the operation was successful, otherwise

430

441

an error code.

431

442

</simpara></listitem></varlistentry>

432

443

<varlistentry><term><parameter>callback_data</parameter> :</term>

435

446

</variablelist></refsect2>

436

447

437

448

<title>GnomeVFSAsyncReadCallback ()</title>

438

<indexterm zone="GnomeVFSAsyncReadCallback"><primary sortas="GnomeVFSAsyncReadCallback">GnomeVFSAsyncReadCallback</primary></indexterm><programlisting><link linkend="void">void</link> (*GnomeVFSAsyncReadCallback) (<link linkend="GnomeVFSAsyncHandle">GnomeVFSAsyncHandle</link> *handle,

449

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

450

<programlisting><link linkend="void">void</link> (*GnomeVFSAsyncReadCallback) (<link linkend="GnomeVFSAsyncHandle">GnomeVFSAsyncHandle</link> *handle,

439

451

440

452

441

453

450

462

<listitem><simpara> handle of the operation generating the callback

451

463

</simpara></listitem></varlistentry>

452

464

<varlistentry><term><parameter>result</parameter> :</term>

453

<listitem><simpara> <link linkend="GNOME-VFS-OK--CAPS"><literal>GNOME_VFS_OK</literal></link> if the operation was successful, otherwise

465

<listitem><simpara> <link linkend="GNOME-VFS-OK:CAPS"><literal>GNOME_VFS_OK</literal></link> if the operation was successful, otherwise

454

466

an error code.

455

467

</simpara></listitem></varlistentry>

456

468

<varlistentry><term><parameter>buffer</parameter> :</term>

469

481

</variablelist></refsect2>

470

482

471

483

<title>GnomeVFSAsyncWriteCallback ()</title>

472

<indexterm zone="GnomeVFSAsyncWriteCallback"><primary sortas="GnomeVFSAsyncWriteCallback">GnomeVFSAsyncWriteCallback</primary></indexterm><programlisting><link linkend="void">void</link> (*GnomeVFSAsyncWriteCallback) (<link linkend="GnomeVFSAsyncHandle">GnomeVFSAsyncHandle</link> *handle,

484

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

485

<programlisting><link linkend="void">void</link> (*GnomeVFSAsyncWriteCallback) (<link linkend="GnomeVFSAsyncHandle">GnomeVFSAsyncHandle</link> *handle,

473

486

474

487

475

488

484

497

<listitem><simpara> handle of the operation generating the callback

485

498

</simpara></listitem></varlistentry>

486

499

<varlistentry><term><parameter>result</parameter> :</term>

487

<listitem><simpara> <link linkend="GNOME-VFS-OK--CAPS"><literal>GNOME_VFS_OK</literal></link> if the operation was successful, otherwise

500

<listitem><simpara> <link linkend="GNOME-VFS-OK:CAPS"><literal>GNOME_VFS_OK</literal></link> if the operation was successful, otherwise

488

501

an error code.

489

502

</simpara></listitem></varlistentry>

490

503

<varlistentry><term><parameter>buffer</parameter> :</term>

503

516

</variablelist></refsect2>

504

517

505

518

<title>GnomeVFSAsyncSeekCallback ()</title>

506

<indexterm zone="GnomeVFSAsyncSeekCallback"><primary sortas="GnomeVFSAsyncSeekCallback">GnomeVFSAsyncSeekCallback</primary></indexterm><programlisting><link linkend="void">void</link> (*GnomeVFSAsyncSeekCallback) (<link linkend="GnomeVFSAsyncHandle">GnomeVFSAsyncHandle</link> *handle,

519

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

520

<programlisting><link linkend="void">void</link> (*GnomeVFSAsyncSeekCallback) (<link linkend="GnomeVFSAsyncHandle">GnomeVFSAsyncHandle</link> *handle,

507

521

508

522

509

523

<para>

515

529

<listitem><simpara> handle of the operation generating the callback

516

530

</simpara></listitem></varlistentry>

517

531

<varlistentry><term><parameter>result</parameter> :</term>

518

<listitem><simpara> <link linkend="GNOME-VFS-OK--CAPS"><literal>GNOME_VFS_OK</literal></link> if the operation was successful, otherwise

532

<listitem><simpara> <link linkend="GNOME-VFS-OK:CAPS"><literal>GNOME_VFS_OK</literal></link> if the operation was successful, otherwise

519

533

an error code.

520

534

</simpara></listitem></varlistentry>

521

535

<varlistentry><term><parameter>callback_data</parameter> :</term>

524

538

</variablelist></refsect2>

525

539

526

540

<title>GnomeVFSAsyncGetFileInfoCallback ()</title>

527

<indexterm zone="GnomeVFSAsyncGetFileInfoCallback"><primary sortas="GnomeVFSAsyncGetFileInfoCallback">GnomeVFSAsyncGetFileInfoCallback</primary></indexterm><programlisting><link linkend="void">void</link> (*GnomeVFSAsyncGetFileInfoCallback) (<link linkend="GnomeVFSAsyncHandle">GnomeVFSAsyncHandle</link> *handle,

541

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

542

<programlisting><link linkend="void">void</link> (*GnomeVFSAsyncGetFileInfoCallback) (<link linkend="GnomeVFSAsyncHandle">GnomeVFSAsyncHandle</link> *handle,

528

543

529

544

530

545

<para>

545

560

</variablelist></refsect2>

546

561

547

562

<title>GnomeVFSAsyncSetFileInfoCallback ()</title>

548

<indexterm zone="GnomeVFSAsyncSetFileInfoCallback"><primary sortas="GnomeVFSAsyncSetFileInfoCallback">GnomeVFSAsyncSetFileInfoCallback</primary></indexterm><programlisting><link linkend="void">void</link> (*GnomeVFSAsyncSetFileInfoCallback) (<link linkend="GnomeVFSAsyncHandle">GnomeVFSAsyncHandle</link> *handle,

563

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

564

<programlisting><link linkend="void">void</link> (*GnomeVFSAsyncSetFileInfoCallback) (<link linkend="GnomeVFSAsyncHandle">GnomeVFSAsyncHandle</link> *handle,

549

565

550

566

551

567

571

587

<listitem><simpara> handle of the operation generating the callback

572

588

</simpara></listitem></varlistentry>

573

589

<varlistentry><term><parameter>result</parameter> :</term>

574

<listitem><simpara> <link linkend="GNOME-VFS-OK--CAPS"><literal>GNOME_VFS_OK</literal></link> if the operation was successful, otherwise a

590

<listitem><simpara> <link linkend="GNOME-VFS-OK:CAPS"><literal>GNOME_VFS_OK</literal></link> if the operation was successful, otherwise a

575

591

576

592

</simpara></listitem></varlistentry>

577

593

578

<listitem><simpara> if <parameter>result</parameter> is <link linkend="GNOME-VFS-OK--CAPS"><literal>GNOME_VFS_OK</literal></link>, a <link linkend="GnomeVFSFileInfo"><type>GnomeVFSFileInfo</type></link> struct containing

594

<listitem><simpara> if <parameter>result</parameter> is <link linkend="GNOME-VFS-OK:CAPS"><literal>GNOME_VFS_OK</literal></link>, a <link linkend="GnomeVFSFileInfo"><type>GnomeVFSFileInfo</type></link> struct containing

579

595

information about the file.

580

596

</simpara></listitem></varlistentry>

581

597

<varlistentry><term><parameter>callback_data</parameter> :</term>

584

600

</variablelist></refsect2>

585

601

586

602

<title>GnomeVFSAsyncFileControlCallback ()</title>

587

<indexterm zone="GnomeVFSAsyncFileControlCallback"><primary sortas="GnomeVFSAsyncFileControlCallback">GnomeVFSAsyncFileControlCallback</primary></indexterm><programlisting><link linkend="void">void</link> (*GnomeVFSAsyncFileControlCallback) (<link linkend="GnomeVFSAsyncHandle">GnomeVFSAsyncHandle</link> *handle,

603

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

604

<programlisting><link linkend="void">void</link> (*GnomeVFSAsyncFileControlCallback) (<link linkend="GnomeVFSAsyncHandle">GnomeVFSAsyncHandle</link> *handle,

588

605

589

606

590

607

598

615

<listitem><simpara> handle of the operation generating the callback

599

616

</simpara></listitem></varlistentry>

600

617

<varlistentry><term><parameter>result</parameter> :</term>

601

<listitem><simpara> <link linkend="GNOME-VFS-OK--CAPS"><literal>GNOME_VFS_OK</literal></link> if the operation was successful, otherwise a

618

<listitem><simpara> <link linkend="GNOME-VFS-OK:CAPS"><literal>GNOME_VFS_OK</literal></link> if the operation was successful, otherwise a

602

619

603

620

</simpara></listitem></varlistentry>

604

621

<varlistentry><term><parameter>operation_data</parameter> :</term>

605

622

<listitem><simpara> The data requested from the module if <parameter>result</parameter>

606

is <link linkend="GNOME-VFS-OK--CAPS"><literal>GNOME_VFS_OK</literal></link>.

623

is <link linkend="GNOME-VFS-OK:CAPS"><literal>GNOME_VFS_OK</literal></link>.

607

624

</simpara></listitem></varlistentry>

608

625

<varlistentry><term><parameter>callback_data</parameter> :</term>

609

626

<listitem><simpara> User data defined when the operation was established.

611

628

</variablelist></refsect2>

612

629

613

630

<title>GnomeVFSAsyncDirectoryLoadCallback ()</title>

614

<indexterm zone="GnomeVFSAsyncDirectoryLoadCallback"><primary sortas="GnomeVFSAsyncDirectoryLoadCallback">GnomeVFSAsyncDirectoryLoadCallback</primary></indexterm><programlisting><link linkend="void">void</link> (*GnomeVFSAsyncDirectoryLoadCallback)

631

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

632

<programlisting><link linkend="void">void</link> (*GnomeVFSAsyncDirectoryLoadCallback)

615

633

(<link linkend="GnomeVFSAsyncHandle">GnomeVFSAsyncHandle</link> *handle,

616

634

617

635

620

638

<para>

621

639

Callback for the <link linkend="gnome-vfs-async-directory-load"><function>gnome_vfs_async_directory_load()</function></link> function.

622

640

informing the user of the <parameter>result</parameter> of the operation and

623

providing a file <parameter>list</parameter> if the <parameter>result</parameter> is <link linkend="GNOME-VFS-OK--CAPS"><literal>GNOME_VFS_OK</literal></link>.</para>

641

providing a file <parameter>list</parameter> if the <parameter>result</parameter> is <link linkend="GNOME-VFS-OK:CAPS"><literal>GNOME_VFS_OK</literal></link>.</para>

624

642

<para>

625

643

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

626

644

<varlistentry><term><parameter>handle</parameter> :</term>

627

645

<listitem><simpara> handle of the operation generating the callback.

628

646

</simpara></listitem></varlistentry>

629

647

<varlistentry><term><parameter>result</parameter> :</term>

630

<listitem><simpara> <link linkend="GNOME-VFS-OK--CAPS"><literal>GNOME_VFS_OK</literal></link> if the operation was sucessful,

631

648

<listitem><simpara> <link linkend="GNOME-VFS-OK:CAPS"><literal>GNOME_VFS_OK</literal></link> if the operation was sucessful,

649

632

650

has been read, otherwise a <link linkend="GnomeVFSResult"><type>GnomeVFSResult</type></link> error code

633

651

</simpara></listitem></varlistentry>

634

652

645

663

</variablelist></refsect2>

646

664

647

665

<title>GnomeVFSAsyncFindDirectoryCallback ()</title>

648

<indexterm zone="GnomeVFSAsyncFindDirectoryCallback"><primary sortas="GnomeVFSAsyncFindDirectoryCallback">GnomeVFSAsyncFindDirectoryCallback</primary></indexterm><programlisting><link linkend="void">void</link> (*GnomeVFSAsyncFindDirectoryCallback)

666

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

667

<programlisting><link linkend="void">void</link> (*GnomeVFSAsyncFindDirectoryCallback)

649

668

(<link linkend="GnomeVFSAsyncHandle">GnomeVFSAsyncHandle</link> *handle,

650

669

651

670

667

686

</variablelist></refsect2>

668

687

669

688

<title>GnomeVFSFindDirectoryResult</title>

670

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

689

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

690

<programlisting>typedef struct {

671

691

GnomeVFSURI *uri;

672

692

GnomeVFSResult result;

673

693

} GnomeVFSFindDirectoryResult;

680

700

<para>

681

701

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

682

702

683

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

703

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

684

704

<listitem><simpara> The <link linkend="GnomeVFSURI"><type>GnomeVFSURI</type></link> that was found.

685

705

</simpara></listitem>

686

706

</varlistentry>

687

707

688

<term><link linkend="GnomeVFSResult">GnomeVFSResult</link> <structfield>result</structfield>;</term>

708

<term><link linkend="GnomeVFSResult">GnomeVFSResult</link> <structfield id="GnomeVFSFindDirectoryResult.result">result</structfield>;</term>

689

709

<listitem><simpara> The <link linkend="GnomeVFSResult"><type>GnomeVFSResult</type></link> that was obtained when finding <parameter>uri</parameter>.

690

710

</simpara></listitem>

691

711

</varlistentry>

692

712

</variablelist></refsect2>

693

713

694

714

<title>GnomeVFSAsyncXferProgressCallback ()</title>

695

<indexterm zone="GnomeVFSAsyncXferProgressCallback"><primary sortas="GnomeVFSAsyncXferProgressCallback">GnomeVFSAsyncXferProgressCallback</primary></indexterm><programlisting><link linkend="gint">gint</link> (*GnomeVFSAsyncXferProgressCallback)

715

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

716

<programlisting><link linkend="gint">gint</link> (*GnomeVFSAsyncXferProgressCallback)

696

717

(<link linkend="GnomeVFSAsyncHandle">GnomeVFSAsyncHandle</link> *handle,

697

718

698

719

704

725

</para>

705

726

<para>

706

727

On the one hand, when the transfer progresses normally,

707

i.e. when the <parameter>info</parameter>'s status is <link linkend="GNOME-VFS-XFER-PROGRESS-STATUS-OK--CAPS"><literal>GNOME_VFS_XFER_PROGRESS_STATUS_OK</literal></link>

728

i.e. when the <parameter>info</parameter>'s status is <link linkend="GNOME-VFS-XFER-PROGRESS-STATUS-OK:CAPS"><literal>GNOME_VFS_XFER_PROGRESS_STATUS_OK</literal></link>

708

729

it is called periodically whenever new progress information

709

730

is available, and it wasn't called already within the last

710

731

100 milliseconds.

712

733

<para>

713

734

On the other hand, it is called whenever a decision is

714

735

requested from the user, i.e. whenever the <parameter>info</parameter>'s <link linkend="status"><literal>status</literal></link>

715

is not <link linkend="GNOME-VFS-XFER-PROGRESS-STATUS-OK--CAPS"><literal>GNOME_VFS_XFER_PROGRESS_STATUS_OK</literal></link>.

736

is not <link linkend="GNOME-VFS-XFER-PROGRESS-STATUS-OK:CAPS"><literal>GNOME_VFS_XFER_PROGRESS_STATUS_OK</literal></link>.

716

737

</para>

717

738

<para>

718

739

Either way, it acts like <link linkend="GnomeVFSXferProgressCallback"><type>GnomeVFSXferProgressCallback</type></link>

730

751

731

752

<listitem><simpara> The user data that was passed to <link linkend="gnome-vfs-async-xfer"><function>gnome_vfs_async_xfer()</function></link>.

732

753

</simpara></listitem></varlistentry>

733

<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="gint"><literal>gint</literal></link> depending on the <link linkend="GnomeVFSXferProgressInfo"><type>GnomeVFSXferProgressInfo</type></link>.

754

<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="gint"><literal>gint</literal></link> depending on the <link linkend="GnomeVFSXferProgressInfo."><type>GnomeVFSXferProgressInfo.</type></link>

734

755

Please consult <link linkend="GnomeVFSXferProgressCallback"><type>GnomeVFSXferProgressCallback</type></link> for details.

735

756

736

757

</simpara></listitem></varlistentry>

737

758

</variablelist></refsect2>

738

759

739

760

<title>GnomeVFSCancellation</title>

740

<indexterm zone="GnomeVFSCancellation"><primary sortas="GnomeVFSCancellation">GnomeVFSCancellation</primary></indexterm><programlisting>typedef struct GnomeVFSCancellation GnomeVFSCancellation;

761

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

762

<programlisting>typedef struct GnomeVFSCancellation GnomeVFSCancellation;

741

763

</programlisting>

742

764

<para>

743

765

</para></refsect2>

744

766

745

767

<title>GnomeVFSContext</title>

746

<indexterm zone="GnomeVFSContext"><primary sortas="GnomeVFSContext">GnomeVFSContext</primary></indexterm><programlisting>typedef struct GnomeVFSContext GnomeVFSContext;

768

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

769

<programlisting>typedef struct GnomeVFSContext GnomeVFSContext;

747

770

</programlisting>

748

771

<para>

749

772

</para></refsect2>

750

773

751

774

<title>gnome_vfs_async_set_job_limit ()</title>

752

<indexterm zone="gnome-vfs-async-set-job-limit"><primary sortas="gnome_vfs_async_set_job_limit">gnome_vfs_async_set_job_limit</primary></indexterm><programlisting><link linkend="void">void</link> gnome_vfs_async_set_job_limit (<link linkend="int">int</link> limit);</programlisting>

775

<indexterm zone="gnome-vfs-async-set-job-limit"><primary>gnome_vfs_async_set_job_limit</primary></indexterm>

776

<programlisting><link linkend="void">void</link> gnome_vfs_async_set_job_limit (<link linkend="int">int</link> limit);</programlisting>

753

777

<para>

754

778

Restrict the number of worker threads used by async operations

755

779

to <parameter>limit</parameter>.</para>

761

785

</variablelist></refsect2>

762

786

763

787

<title>gnome_vfs_async_get_job_limit ()</title>

764

<indexterm zone="gnome-vfs-async-get-job-limit"><primary sortas="gnome_vfs_async_get_job_limit">gnome_vfs_async_get_job_limit</primary></indexterm><programlisting><link linkend="int">int</link> gnome_vfs_async_get_job_limit (void);</programlisting>

788

<indexterm zone="gnome-vfs-async-get-job-limit"><primary>gnome_vfs_async_get_job_limit</primary></indexterm>

789

<programlisting><link linkend="int">int</link> gnome_vfs_async_get_job_limit (void);</programlisting>

765

790

<para>

766

791

Get the current maximum allowable number of

767

792

worker threads for async operations.</para>

772

797

</variablelist></refsect2>

773

798

774

799

<title>gnome_vfs_async_cancel ()</title>

775

<indexterm zone="gnome-vfs-async-cancel"><primary sortas="gnome_vfs_async_cancel">gnome_vfs_async_cancel</primary></indexterm><programlisting><link linkend="void">void</link> gnome_vfs_async_cancel (<link linkend="GnomeVFSAsyncHandle">GnomeVFSAsyncHandle</link> *handle);</programlisting>

800

<indexterm zone="gnome-vfs-async-cancel"><primary>gnome_vfs_async_cancel</primary></indexterm>

801

<programlisting><link linkend="void">void</link> gnome_vfs_async_cancel (<link linkend="GnomeVFSAsyncHandle">GnomeVFSAsyncHandle</link> *handle);</programlisting>

776

802

<para>

777

803

Cancel an asynchronous operation and close all its callbacks.

778

804

</para>

810

836

</variablelist></refsect2>

811

837

812

838

<title>gnome_vfs_async_open ()</title>

813

<indexterm zone="gnome-vfs-async-open"><primary sortas="gnome_vfs_async_open">gnome_vfs_async_open</primary></indexterm><programlisting><link linkend="void">void</link> gnome_vfs_async_open (<link linkend="GnomeVFSAsyncHandle">GnomeVFSAsyncHandle</link> **handle_return,

839

<indexterm zone="gnome-vfs-async-open"><primary>gnome_vfs_async_open</primary></indexterm>

840

<programlisting><link linkend="void">void</link> gnome_vfs_async_open (<link linkend="GnomeVFSAsyncHandle">GnomeVFSAsyncHandle</link> **handle_return,

814

841

const <link linkend="gchar">gchar</link> *text_uri,

815

842

816

843

819

846

<para>

820

847

Open <parameter>text_uri</parameter> according to mode <parameter>open_mode</parameter>. On return, <parameter>handle_return</parameter> will

821

848

contain a pointer to the operation. Once the file has been successfully opened,

822

<parameter>callback</parameter> will be called with the <link linkend="GnomeVFSResult"><type>GnomeVFSResult</type></link>.</para>

849

<parameter>callback</parameter> will be called with the <link linkend="GnomeVFSResult."><type>GnomeVFSResult.</type></link></para>

823

850

<para>

824

851

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

825

852

<varlistentry><term><parameter>handle_return</parameter> :</term>

832

859

<listitem><simpara> open mode.

833

860

</simpara></listitem></varlistentry>

834

861

<varlistentry><term><parameter>priority</parameter> :</term>

835

<listitem><simpara> a value from <link linkend="GNOME-VFS-PRIORITY-MIN--CAPS"><literal>GNOME_VFS_PRIORITY_MIN</literal></link> to <link linkend="GNOME-VFS-PRIORITY-MAX--CAPS"><literal>GNOME_VFS_PRIORITY_MAX</literal></link> (normally

836

should be <link linkend="GNOME-VFS-PRIORITY-DEFAULT--CAPS"><literal>GNOME_VFS_PRIORITY_DEFAULT</literal></link>) indicating the priority to assign to this job

862

<listitem><simpara> a value from <link linkend="GNOME-VFS-PRIORITY-MIN:CAPS"><literal>GNOME_VFS_PRIORITY_MIN</literal></link> to <link linkend="GNOME-VFS-PRIORITY-MAX:CAPS"><literal>GNOME_VFS_PRIORITY_MAX</literal></link> (normally

863

should be <link linkend="GNOME-VFS-PRIORITY-DEFAULT:CAPS"><literal>GNOME_VFS_PRIORITY_DEFAULT</literal></link>) indicating the priority to assign to this job

837

864

in allocating threads from the thread pool.

838

865

</simpara></listitem></varlistentry>

839

866

<varlistentry><term><parameter>callback</parameter> :</term>

845

872

</variablelist></refsect2>

846

873

847

874

<title>gnome_vfs_async_open_uri ()</title>

848

<indexterm zone="gnome-vfs-async-open-uri"><primary sortas="gnome_vfs_async_open_uri">gnome_vfs_async_open_uri</primary></indexterm><programlisting><link linkend="void">void</link> gnome_vfs_async_open_uri (<link linkend="GnomeVFSAsyncHandle">GnomeVFSAsyncHandle</link> **handle_return,

875

<indexterm zone="gnome-vfs-async-open-uri"><primary>gnome_vfs_async_open_uri</primary></indexterm>

876

<programlisting><link linkend="void">void</link> gnome_vfs_async_open_uri (<link linkend="GnomeVFSAsyncHandle">GnomeVFSAsyncHandle</link> **handle_return,

849

877

850

878

851

879

854

882

<para>

855

883

Open <parameter>uri</parameter> according to mode <parameter>open_mode</parameter>. On return, <parameter>handle_return</parameter> will

856

884

contain a pointer to the operation. Once the file has been successfully opened,

857

<parameter>callback</parameter> will be called with the <link linkend="GnomeVFSResult"><type>GnomeVFSResult</type></link>.</para>

885

<parameter>callback</parameter> will be called with the <link linkend="GnomeVFSResult."><type>GnomeVFSResult.</type></link></para>

858

886

<para>

859

887

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

860

888

<varlistentry><term><parameter>handle_return</parameter> :</term>

867

895

<listitem><simpara> open mode.

868

896

</simpara></listitem></varlistentry>

869

897

<varlistentry><term><parameter>priority</parameter> :</term>

870

<listitem><simpara> a value from <link linkend="GNOME-VFS-PRIORITY-MIN--CAPS"><literal>GNOME_VFS_PRIORITY_MIN</literal></link> to <link linkend="GNOME-VFS-PRIORITY-MAX--CAPS"><literal>GNOME_VFS_PRIORITY_MAX</literal></link> (normally

871

should be <link linkend="GNOME-VFS-PRIORITY-DEFAULT--CAPS"><literal>GNOME_VFS_PRIORITY_DEFAULT</literal></link>) indicating the priority to assign to this job

898

<listitem><simpara> a value from <link linkend="GNOME-VFS-PRIORITY-MIN:CAPS"><literal>GNOME_VFS_PRIORITY_MIN</literal></link> to <link linkend="GNOME-VFS-PRIORITY-MAX:CAPS"><literal>GNOME_VFS_PRIORITY_MAX</literal></link> (normally

899

should be <link linkend="GNOME-VFS-PRIORITY-DEFAULT:CAPS"><literal>GNOME_VFS_PRIORITY_DEFAULT</literal></link>) indicating the priority to assign to this job

872

900

in allocating threads from the thread pool.

873

901

</simpara></listitem></varlistentry>

874

902

<varlistentry><term><parameter>callback</parameter> :</term>

880

908

</variablelist></refsect2>

881

909

882

910

<title>gnome_vfs_async_open_as_channel ()</title>

883

<indexterm zone="gnome-vfs-async-open-as-channel" role="deprecated"><primary sortas="gnome_vfs_async_open_as_channel">gnome_vfs_async_open_as_channel</primary></indexterm><programlisting><link linkend="void">void</link> gnome_vfs_async_open_as_channel (<link linkend="GnomeVFSAsyncHandle">GnomeVFSAsyncHandle</link> **handle_return,

911

<indexterm zone="gnome-vfs-async-open-as-channel" role="deprecated"><primary>gnome_vfs_async_open_as_channel</primary></indexterm>

912

<programlisting><link linkend="void">void</link> gnome_vfs_async_open_as_channel (<link linkend="GnomeVFSAsyncHandle">GnomeVFSAsyncHandle</link> **handle_return,

884

913

const <link linkend="gchar">gchar</link> *text_uri,

885

914

886

915

889

918

890

919

<warning><para><literal>gnome_vfs_async_open_as_channel</literal> is deprecated and should not be used in newly-written code.</para></warning>

891

920

<para>

892

Open <parameter>text_uri</parameter> as a <link linkend="GIOChannel"><type>GIOChannel</type></link>. Once the channel has been established

921

Open <parameter>text_uri</parameter> as a <link linkend="GIOChannel."><type>GIOChannel.</type></link> Once the channel has been established

893

922

<parameter>callback</parameter> will be called with <parameter>callback_data</parameter>, the result of the operation,

894

and if the result was <link linkend="GNOME-VFS-OK--CAPS"><literal>GNOME_VFS_OK</literal></link>, a reference to a <link linkend="GIOChannel"><type>GIOChannel</type></link> pointing

923

and if the result was <link linkend="GNOME-VFS-OK:CAPS"><literal>GNOME_VFS_OK</literal></link>, a reference to a <link linkend="GIOChannel"><type>GIOChannel</type></link> pointing

895

924

at <parameter>text_uri</parameter> in <parameter>open_mode</parameter>.

896

925

</para>

897

926

<para>

898

927

This function has been deprecated due to behaving weirdly which suggests

899

that it hasn't been used. See bugs <link linkend="157266--CAPS"><type>157266</type></link>, <link linkend="157265--CAPS"><type>157265</type></link>, <link linkend="157261--CAPS"><type>157261</type></link>, <link linkend="138398--CAPS"><type>138398</type></link> in

928

that it hasn't been used. See bugs <link linkend="157266:CAPS"><type>157266</type></link>, <link linkend="157265:CAPS"><type>157265</type></link>, <link linkend="157261:CAPS"><type>157261</type></link>, <link linkend="138398:CAPS"><type>138398</type></link> in

900

929

the GNOME Bugzilla. If the *_as_channel functions are needed they should be

901

930

fixed and undeprecated.</para>

902

931

<para>

905

934

<listitem><simpara> pointer to a pointer to a <link linkend="GnomeVFSHandle"><type>GnomeVFSHandle</type></link> object.

906

935

</simpara></listitem></varlistentry>

907

936

908

<listitem><simpara> string of the uri to open as a <link linkend="GIOChannel"><type>GIOChannel</type></link>.

937

<listitem><simpara> string of the uri to open as a <link linkend="GIOChannel."><type>GIOChannel.</type></link>

909

938

</simpara></listitem></varlistentry>

910

939

911

940

<listitem><simpara> open mode i.e. for reading, writing, random, etc.

914

943

<listitem><simpara> the preferred block size for <link linkend="GIOChannel"><type>GIOChannel</type></link> to read.

915

944

</simpara></listitem></varlistentry>

916

945

<varlistentry><term><parameter>priority</parameter> :</term>

917

<listitem><simpara> a value from <link linkend="GNOME-VFS-PRIORITY-MIN--CAPS"><literal>GNOME_VFS_PRIORITY_MIN</literal></link> to <link linkend="GNOME-VFS-PRIORITY-MAX--CAPS"><literal>GNOME_VFS_PRIORITY_MAX</literal></link> (normally

918

should be <link linkend="GNOME-VFS-PRIORITY-DEFAULT--CAPS"><literal>GNOME_VFS_PRIORITY_DEFAULT</literal></link>) indicating the priority to assign this job

946

<listitem><simpara> a value from <link linkend="GNOME-VFS-PRIORITY-MIN:CAPS"><literal>GNOME_VFS_PRIORITY_MIN</literal></link> to <link linkend="GNOME-VFS-PRIORITY-MAX:CAPS"><literal>GNOME_VFS_PRIORITY_MAX</literal></link> (normally

947

should be <link linkend="GNOME-VFS-PRIORITY-DEFAULT:CAPS"><literal>GNOME_VFS_PRIORITY_DEFAULT</literal></link>) indicating the priority to assign this job

919

948

in allocating threads from the thread pool.

920

949

</simpara></listitem></varlistentry>

921

950

<varlistentry><term><parameter>callback</parameter> :</term>

927

956

</variablelist></refsect2>

928

957

929

958

<title>gnome_vfs_async_open_uri_as_channel ()</title>

930

<indexterm zone="gnome-vfs-async-open-uri-as-channel" role="deprecated"><primary sortas="gnome_vfs_async_open_uri_as_channel">gnome_vfs_async_open_uri_as_channel</primary></indexterm><programlisting><link linkend="void">void</link> gnome_vfs_async_open_uri_as_channel (<link linkend="GnomeVFSAsyncHandle">GnomeVFSAsyncHandle</link> **handle_return,

959

<indexterm zone="gnome-vfs-async-open-uri-as-channel" role="deprecated"><primary>gnome_vfs_async_open_uri_as_channel</primary></indexterm>

960

<programlisting><link linkend="void">void</link> gnome_vfs_async_open_uri_as_channel (<link linkend="GnomeVFSAsyncHandle">GnomeVFSAsyncHandle</link> **handle_return,

931

961

932

962

933

963

935

965

936

966

937

967

<warning><para><literal>gnome_vfs_async_open_uri_as_channel</literal> is deprecated and should not be used in newly-written code. This function has been deprecated due to behaving weirdly which suggests

938

that it shouldn't be used. See bugs <link linkend="157266--CAPS"><type>157266</type></link>, <link linkend="157265--CAPS"><type>157265</type></link>, <link linkend="157261--CAPS"><type>157261</type></link>, <link linkend="138398--CAPS"><type>138398</type></link> in

968

that it shouldn't be used. See bugs <link linkend="157266:CAPS"><type>157266</type></link>, <link linkend="157265:CAPS"><type>157265</type></link>, <link linkend="157261:CAPS"><type>157261</type></link>, <link linkend="138398:CAPS"><type>138398</type></link> in

939

969

the GNOME Bugzilla. If the *_as_channel functions are needed they should be

940

970

fixed and undeprecated.</para></warning>

941

971

<para>

942

Open <parameter>uri</parameter> as a <link linkend="GIOChannel"><type>GIOChannel</type></link>. Once the channel has been established

972

Open <parameter>uri</parameter> as a <link linkend="GIOChannel."><type>GIOChannel.</type></link> Once the channel has been established

943

973

<parameter>callback</parameter> will be called with <parameter>callback_data</parameter>, the result of the operation,

944

and if the result was <link linkend="GNOME-VFS-OK--CAPS"><literal>GNOME_VFS_OK</literal></link>, a reference to a <link linkend="GIOChannel"><type>GIOChannel</type></link> pointing

974

and if the result was <link linkend="GNOME-VFS-OK:CAPS"><literal>GNOME_VFS_OK</literal></link>, a reference to a <link linkend="GIOChannel"><type>GIOChannel</type></link> pointing

945

975

at <parameter>uri</parameter> in <parameter>open_mode</parameter>.</para>

946

976

<para>

947

977

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

949

979

<listitem><simpara> pointer to a pointer to a <link linkend="GnomeVFSHandle"><type>GnomeVFSHandle</type></link> object.

950

980

</simpara></listitem></varlistentry>

951

981

952

<listitem><simpara> uri to open as a <link linkend="GIOChannel"><type>GIOChannel</type></link>.

982

<listitem><simpara> uri to open as a <link linkend="GIOChannel."><type>GIOChannel.</type></link>

953

983

</simpara></listitem></varlistentry>

954

984

955

985

<listitem><simpara> open mode i.e. for reading, writing, random, etc.

958

988

<listitem><simpara> the preferred block size for <link linkend="GIOChannel"><type>GIOChannel</type></link> to read.

959

989

</simpara></listitem></varlistentry>

960

990

<varlistentry><term><parameter>priority</parameter> :</term>

961

<listitem><simpara> a value from <link linkend="GNOME-VFS-PRIORITY-MIN--CAPS"><literal>GNOME_VFS_PRIORITY_MIN</literal></link> to <link linkend="GNOME-VFS-PRIORITY-MAX--CAPS"><literal>GNOME_VFS_PRIORITY_MAX</literal></link> (normally

962

should be <link linkend="GNOME-VFS-PRIORITY-DEFAULT--CAPS"><literal>GNOME_VFS_PRIORITY_DEFAULT</literal></link>) indicating the priority to assign this job

991

<listitem><simpara> a value from <link linkend="GNOME-VFS-PRIORITY-MIN:CAPS"><literal>GNOME_VFS_PRIORITY_MIN</literal></link> to <link linkend="GNOME-VFS-PRIORITY-MAX:CAPS"><literal>GNOME_VFS_PRIORITY_MAX</literal></link> (normally

992

should be <link linkend="GNOME-VFS-PRIORITY-DEFAULT:CAPS"><literal>GNOME_VFS_PRIORITY_DEFAULT</literal></link>) indicating the priority to assign this job

963

993

in allocating threads from the thread pool.

964

994

</simpara></listitem></varlistentry>

965

995

<varlistentry><term><parameter>callback</parameter> :</term>

971

1001

</variablelist></refsect2>

972

1002

973

1003

<title>gnome_vfs_async_create ()</title>

974

<indexterm zone="gnome-vfs-async-create"><primary sortas="gnome_vfs_async_create">gnome_vfs_async_create</primary></indexterm><programlisting><link linkend="void">void</link> gnome_vfs_async_create (<link linkend="GnomeVFSAsyncHandle">GnomeVFSAsyncHandle</link> **handle_return,

1004

<indexterm zone="gnome-vfs-async-create"><primary>gnome_vfs_async_create</primary></indexterm>

1005

<programlisting><link linkend="void">void</link> gnome_vfs_async_create (<link linkend="GnomeVFSAsyncHandle">GnomeVFSAsyncHandle</link> **handle_return,

975

1006

const <link linkend="gchar">gchar</link> *text_uri,

976

1007

977

1008

992

1023

<listitem><simpara> string representing the uri to create.

993

1024

</simpara></listitem></varlistentry>

994

1025

995

<listitem><simpara> mode to leave the file opened in after creation (or <link linkend="GNOME-VFS-OPEN-MODE-NONE--CAPS"><literal>GNOME_VFS_OPEN_MODE_NONE</literal></link>

1026

<listitem><simpara> mode to leave the file opened in after creation (or <link linkend="GNOME-VFS-OPEN-MODE-NONE:CAPS"><literal>GNOME_VFS_OPEN_MODE_NONE</literal></link>

996

1027

to leave the file closed after creation).

997

1028

</simpara></listitem></varlistentry>

998

1029

<varlistentry><term><parameter>exclusive</parameter> :</term>

1005

1036

(Unix style).

1006

1037

</simpara></listitem></varlistentry>

1007

1038

<varlistentry><term><parameter>priority</parameter> :</term>

1008

<listitem><simpara> a value from <link linkend="GNOME-VFS-PRIORITY-MIN--CAPS"><literal>GNOME_VFS_PRIORITY_MIN</literal></link> to <link linkend="GNOME-VFS-PRIORITY-MAX--CAPS"><literal>GNOME_VFS_PRIORITY_MAX</literal></link> (normally

1009

should be <link linkend="GNOME-VFS-PRIORITY-DEFAULT--CAPS"><literal>GNOME_VFS_PRIORITY_DEFAULT</literal></link>) indicating the priority to assign this job

1039

<listitem><simpara> a value from <link linkend="GNOME-VFS-PRIORITY-MIN:CAPS"><literal>GNOME_VFS_PRIORITY_MIN</literal></link> to <link linkend="GNOME-VFS-PRIORITY-MAX:CAPS"><literal>GNOME_VFS_PRIORITY_MAX</literal></link> (normally

1040

should be <link linkend="GNOME-VFS-PRIORITY-DEFAULT:CAPS"><literal>GNOME_VFS_PRIORITY_DEFAULT</literal></link>) indicating the priority to assign this job

1010

1041

in allocating threads from the thread pool.

1011

1042

</simpara></listitem></varlistentry>

1012

1043

<varlistentry><term><parameter>callback</parameter> :</term>

1018

1049

</variablelist></refsect2>

1019

1050

1020

1051

<title>gnome_vfs_async_create_uri ()</title>

1021

<indexterm zone="gnome-vfs-async-create-uri"><primary sortas="gnome_vfs_async_create_uri">gnome_vfs_async_create_uri</primary></indexterm><programlisting><link linkend="void">void</link> gnome_vfs_async_create_uri (<link linkend="GnomeVFSAsyncHandle">GnomeVFSAsyncHandle</link> **handle_return,

1052

<indexterm zone="gnome-vfs-async-create-uri"><primary>gnome_vfs_async_create_uri</primary></indexterm>

1053

<programlisting><link linkend="void">void</link> gnome_vfs_async_create_uri (<link linkend="GnomeVFSAsyncHandle">GnomeVFSAsyncHandle</link> **handle_return,

1022

1054

1023

1055

1024

1056

1039

1071

<listitem><simpara> uri to create a file at.

1040

1072

</simpara></listitem></varlistentry>

1041

1073

1042

<listitem><simpara> mode to leave the file opened in after creation (or <link linkend="GNOME-VFS-OPEN-MODE-NONE--CAPS"><literal>GNOME_VFS_OPEN_MODE_NONE</literal></link>

1074

<listitem><simpara> mode to leave the file opened in after creation (or <link linkend="GNOME-VFS-OPEN-MODE-NONE:CAPS"><literal>GNOME_VFS_OPEN_MODE_NONE</literal></link>

1043

1075

to leave the file closed after creation).

1044

1076

</simpara></listitem></varlistentry>

1045

1077

<varlistentry><term><parameter>exclusive</parameter> :</term>

1052

1084

(Unix style).

1053

1085

</simpara></listitem></varlistentry>

1054

1086

<varlistentry><term><parameter>priority</parameter> :</term>

1055

<listitem><simpara> a value from <link linkend="GNOME-VFS-PRIORITY-MIN--CAPS"><literal>GNOME_VFS_PRIORITY_MIN</literal></link> to <link linkend="GNOME-VFS-PRIORITY-MAX--CAPS"><literal>GNOME_VFS_PRIORITY_MAX</literal></link> (normally

1056

should be <link linkend="GNOME-VFS-PRIORITY-DEFAULT--CAPS"><literal>GNOME_VFS_PRIORITY_DEFAULT</literal></link>) indicating the priority to assign this job

1087

<listitem><simpara> a value from <link linkend="GNOME-VFS-PRIORITY-MIN:CAPS"><literal>GNOME_VFS_PRIORITY_MIN</literal></link> to <link linkend="GNOME-VFS-PRIORITY-MAX:CAPS"><literal>GNOME_VFS_PRIORITY_MAX</literal></link> (normally

1088

should be <link linkend="GNOME-VFS-PRIORITY-DEFAULT:CAPS"><literal>GNOME_VFS_PRIORITY_DEFAULT</literal></link>) indicating the priority to assign this job

1057

1089

in allocating threads from the thread pool.

1058

1090

</simpara></listitem></varlistentry>

1059

1091

<varlistentry><term><parameter>callback</parameter> :</term>

1065

1097

</variablelist></refsect2>

1066

1098

1067

1099

<title>gnome_vfs_async_create_symbolic_link ()</title>

1068

<indexterm zone="gnome-vfs-async-create-symbolic-link"><primary sortas="gnome_vfs_async_create_symbolic_link">gnome_vfs_async_create_symbolic_link</primary></indexterm><programlisting><link linkend="void">void</link> gnome_vfs_async_create_symbolic_link

1100

<indexterm zone="gnome-vfs-async-create-symbolic-link"><primary>gnome_vfs_async_create_symbolic_link</primary></indexterm>

1101

<programlisting><link linkend="void">void</link> gnome_vfs_async_create_symbolic_link

1069

1102

(<link linkend="GnomeVFSAsyncHandle">GnomeVFSAsyncHandle</link> **handle_return,

1070

1103

1071

1104

const <link linkend="gchar">gchar</link> *uri_reference,

1089

1122

<listitem><simpara> location to point <parameter>uri</parameter> to (can be a uri fragment, i.e. relative).

1090

1123

</simpara></listitem></varlistentry>

1091

1124

<varlistentry><term><parameter>priority</parameter> :</term>

1092

<listitem><simpara> a value from <link linkend="GNOME-VFS-PRIORITY-MIN--CAPS"><literal>GNOME_VFS_PRIORITY_MIN</literal></link> to <link linkend="GNOME-VFS-PRIORITY-MAX--CAPS"><literal>GNOME_VFS_PRIORITY_MAX</literal></link> (normally

1093

should be <link linkend="GNOME-VFS-PRIORITY-DEFAULT--CAPS"><literal>GNOME_VFS_PRIORITY_DEFAULT</literal></link>) indicating the priority to assign to this job

1125

<listitem><simpara> a value from <link linkend="GNOME-VFS-PRIORITY-MIN:CAPS"><literal>GNOME_VFS_PRIORITY_MIN</literal></link> to <link linkend="GNOME-VFS-PRIORITY-MAX:CAPS"><literal>GNOME_VFS_PRIORITY_MAX</literal></link> (normally

1126

should be <link linkend="GNOME-VFS-PRIORITY-DEFAULT:CAPS"><literal>GNOME_VFS_PRIORITY_DEFAULT</literal></link>) indicating the priority to assign to this job

1094

1127

in allocating threads from the thread pool.

1095

1128

</simpara></listitem></varlistentry>

1096

1129

<varlistentry><term><parameter>callback</parameter> :</term>

1102

1135

</variablelist></refsect2>

1103

1136

1104

1137

<title>gnome_vfs_async_create_as_channel ()</title>

1105

<indexterm zone="gnome-vfs-async-create-as-channel" role="deprecated"><primary sortas="gnome_vfs_async_create_as_channel">gnome_vfs_async_create_as_channel</primary></indexterm><programlisting><link linkend="void">void</link> gnome_vfs_async_create_as_channel (<link linkend="GnomeVFSAsyncHandle">GnomeVFSAsyncHandle</link> **handle_return,

1138

<indexterm zone="gnome-vfs-async-create-as-channel" role="deprecated"><primary>gnome_vfs_async_create_as_channel</primary></indexterm>

1139

<programlisting><link linkend="void">void</link> gnome_vfs_async_create_as_channel (<link linkend="GnomeVFSAsyncHandle">GnomeVFSAsyncHandle</link> **handle_return,

1106

1140

const <link linkend="gchar">gchar</link> *text_uri,

1107

1141

1108

1142

1114

1148

<para>

1115

1149

Open <parameter>text_uri</parameter> as a <link linkend="GIOChannel"><type>GIOChannel</type></link>, creating it as necessary. Once the channel has

1116

1150

been established <parameter>callback</parameter> will be called with <parameter>callback_data</parameter>, the result of the

1117

operation, and if the result was <link linkend="GNOME-VFS-OK--CAPS"><literal>GNOME_VFS_OK</literal></link>, a reference to a <link linkend="GIOChannel"><type>GIOChannel</type></link> pointing

1151

operation, and if the result was <link linkend="GNOME-VFS-OK:CAPS"><literal>GNOME_VFS_OK</literal></link>, a reference to a <link linkend="GIOChannel"><type>GIOChannel</type></link> pointing

1118

1152

at <parameter>text_uri</parameter> in <parameter>open_mode</parameter>.

1119

1153

</para>

1120

1154

<para>

1121

1155

This function has been deprecated due to behaving weirdly which suggests

1122

that it hasn't been used. See bugs <link linkend="157266--CAPS"><type>157266</type></link>, <link linkend="157265--CAPS"><type>157265</type></link>, <link linkend="157261--CAPS"><type>157261</type></link>, <link linkend="138398--CAPS"><type>138398</type></link> in

1156

that it hasn't been used. See bugs <link linkend="157266:CAPS"><type>157266</type></link>, <link linkend="157265:CAPS"><type>157265</type></link>, <link linkend="157261:CAPS"><type>157261</type></link>, <link linkend="138398:CAPS"><type>138398</type></link> in

1123

1157

the GNOME Bugzilla. If the *_as_channel functions are needed they should be

1124

1158

fixed and undeprecated.</para>

1125

1159

<para>

1140

1174

<listitem><simpara> standard POSIX-style permissions bitmask, permissions of created file.

1141

1175

</simpara></listitem></varlistentry>

1142

1176

<varlistentry><term><parameter>priority</parameter> :</term>

1143

<listitem><simpara> a value from <link linkend="GNOME-VFS-PRIORITY-MIN--CAPS"><literal>GNOME_VFS_PRIORITY_MIN</literal></link> to <link linkend="GNOME-VFS-PRIORITY-MAX--CAPS"><literal>GNOME_VFS_PRIORITY_MAX</literal></link> (normally

1144

should be <link linkend="GNOME-VFS-PRIORITY-DEFAULT--CAPS"><literal>GNOME_VFS_PRIORITY_DEFAULT</literal></link>) indicating the priority to assign this job

1177

<listitem><simpara> a value from <link linkend="GNOME-VFS-PRIORITY-MIN:CAPS"><literal>GNOME_VFS_PRIORITY_MIN</literal></link> to <link linkend="GNOME-VFS-PRIORITY-MAX:CAPS"><literal>GNOME_VFS_PRIORITY_MAX</literal></link> (normally

1178

should be <link linkend="GNOME-VFS-PRIORITY-DEFAULT:CAPS"><literal>GNOME_VFS_PRIORITY_DEFAULT</literal></link>) indicating the priority to assign this job

1145

1179

in allocating threads from the thread pool.

1146

1180

</simpara></listitem></varlistentry>

1147

1181

<varlistentry><term><parameter>callback</parameter> :</term>

1153

1187

</variablelist></refsect2>

1154

1188

1155

1189

<title>gnome_vfs_async_create_uri_as_channel ()</title>

1156

<indexterm zone="gnome-vfs-async-create-uri-as-channel" role="deprecated"><primary sortas="gnome_vfs_async_create_uri_as_channel">gnome_vfs_async_create_uri_as_channel</primary></indexterm><indexterm zone="gnome-vfs-async-create-uri-as-channel" role="2.12"><primary sortas="gnome_vfs_async_create_uri_as_channel">gnome_vfs_async_create_uri_as_channel</primary></indexterm><programlisting><link linkend="void">void</link> gnome_vfs_async_create_uri_as_channel

1190

<indexterm zone="gnome-vfs-async-create-uri-as-channel" role="deprecated"><primary>gnome_vfs_async_create_uri_as_channel</primary></indexterm><indexterm zone="gnome-vfs-async-create-uri-as-channel" role="2.12"><primary>gnome_vfs_async_create_uri_as_channel</primary></indexterm>

1191

<programlisting><link linkend="void">void</link> gnome_vfs_async_create_uri_as_channel

1157

1192

(<link linkend="GnomeVFSAsyncHandle">GnomeVFSAsyncHandle</link> **handle_return,

1158

1193

1159

1194

1166

1201

<para>

1167

1202

Open <parameter>uri</parameter> as a <link linkend="GIOChannel"><type>GIOChannel</type></link>, creating it as necessary. Once the channel has

1168

1203

been established <parameter>callback</parameter> will be called with <parameter>callback_data</parameter>, the result of the

1169

operation, and if the result was <link linkend="GNOME-VFS-OK--CAPS"><literal>GNOME_VFS_OK</literal></link>, a reference to a <link linkend="GIOChannel"><type>GIOChannel</type></link> pointing

1204

operation, and if the result was <link linkend="GNOME-VFS-OK:CAPS"><literal>GNOME_VFS_OK</literal></link>, a reference to a <link linkend="GIOChannel"><type>GIOChannel</type></link> pointing

1170

1205

at <parameter>text_uri</parameter> in <parameter>open_mode</parameter>.</para>

1171

1206

<para>

1172

1207

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

1186

1221

<listitem><simpara> standard POSIX-style permissions bitmask, permissions of created file.

1187

1222

</simpara></listitem></varlistentry>

1188

1223

<varlistentry><term><parameter>priority</parameter> :</term>

1189

<listitem><simpara> a value from <link linkend="GNOME-VFS-PRIORITY-MIN--CAPS"><literal>GNOME_VFS_PRIORITY_MIN</literal></link> to <link linkend="GNOME-VFS-PRIORITY-MAX--CAPS"><literal>GNOME_VFS_PRIORITY_MAX</literal></link> (normally

1190

should be <link linkend="GNOME-VFS-PRIORITY-DEFAULT--CAPS"><literal>GNOME_VFS_PRIORITY_DEFAULT</literal></link>) indicating the priority to assign this job

1224

<listitem><simpara> a value from <link linkend="GNOME-VFS-PRIORITY-MIN:CAPS"><literal>GNOME_VFS_PRIORITY_MIN</literal></link> to <link linkend="GNOME-VFS-PRIORITY-MAX:CAPS"><literal>GNOME_VFS_PRIORITY_MAX</literal></link> (normally

1225

should be <link linkend="GNOME-VFS-PRIORITY-DEFAULT:CAPS"><literal>GNOME_VFS_PRIORITY_DEFAULT</literal></link>) indicating the priority to assign this job

1191

1226

in allocating threads from the thread pool.

1192

1227

</simpara></listitem></varlistentry>

1193

1228

<varlistentry><term><parameter>callback</parameter> :</term>

1199

1234

</variablelist><para role="since">Since 2.12</para></refsect2>

1200

1235

1201

1236

<title>gnome_vfs_async_close ()</title>

1202

<indexterm zone="gnome-vfs-async-close"><primary sortas="gnome_vfs_async_close">gnome_vfs_async_close</primary></indexterm><programlisting><link linkend="void">void</link> gnome_vfs_async_close (<link linkend="GnomeVFSAsyncHandle">GnomeVFSAsyncHandle</link> *handle,

1237

<indexterm zone="gnome-vfs-async-close"><primary>gnome_vfs_async_close</primary></indexterm>

1238

<programlisting><link linkend="void">void</link> gnome_vfs_async_close (<link linkend="GnomeVFSAsyncHandle">GnomeVFSAsyncHandle</link> *handle,

1203

1239

1204

1240

1205

1241

<para>

1220

1256

</variablelist></refsect2>

1221

1257

1222

1258

<title>gnome_vfs_async_read ()</title>

1223

<indexterm zone="gnome-vfs-async-read"><primary sortas="gnome_vfs_async_read">gnome_vfs_async_read</primary></indexterm><programlisting><link linkend="void">void</link> gnome_vfs_async_read (<link linkend="GnomeVFSAsyncHandle">GnomeVFSAsyncHandle</link> *handle,

1259

<indexterm zone="gnome-vfs-async-read"><primary>gnome_vfs_async_read</primary></indexterm>

1260

<programlisting><link linkend="void">void</link> gnome_vfs_async_read (<link linkend="GnomeVFSAsyncHandle">GnomeVFSAsyncHandle</link> *handle,

1224

1261

1225

1262

1226

1263

1249

1286

</variablelist></refsect2>

1250

1287

1251

1288

<title>gnome_vfs_async_write ()</title>

1252

<indexterm zone="gnome-vfs-async-write"><primary sortas="gnome_vfs_async_write">gnome_vfs_async_write</primary></indexterm><programlisting><link linkend="void">void</link> gnome_vfs_async_write (<link linkend="GnomeVFSAsyncHandle">GnomeVFSAsyncHandle</link> *handle,

1289

<indexterm zone="gnome-vfs-async-write"><primary>gnome_vfs_async_write</primary></indexterm>

1290

<programlisting><link linkend="void">void</link> gnome_vfs_async_write (<link linkend="GnomeVFSAsyncHandle">GnomeVFSAsyncHandle</link> *handle,

1253

1291

1254

1292

1255

1293

1278

1316

</variablelist></refsect2>

1279

1317

1280

1318

<title>gnome_vfs_async_seek ()</title>

1281

<indexterm zone="gnome-vfs-async-seek"><primary sortas="gnome_vfs_async_seek">gnome_vfs_async_seek</primary></indexterm><programlisting><link linkend="void">void</link> gnome_vfs_async_seek (<link linkend="GnomeVFSAsyncHandle">GnomeVFSAsyncHandle</link> *handle,

1319

<indexterm zone="gnome-vfs-async-seek"><primary>gnome_vfs_async_seek</primary></indexterm>

1320

<programlisting><link linkend="void">void</link> gnome_vfs_async_seek (<link linkend="GnomeVFSAsyncHandle">GnomeVFSAsyncHandle</link> *handle,

1282

1321

1283

1322

1284

1323

1308

1347

</variablelist></refsect2>

1309

1348

1310

1349

<title>gnome_vfs_async_get_file_info ()</title>

1311

<indexterm zone="gnome-vfs-async-get-file-info"><primary sortas="gnome_vfs_async_get_file_info">gnome_vfs_async_get_file_info</primary></indexterm><programlisting><link linkend="void">void</link> gnome_vfs_async_get_file_info (<link linkend="GnomeVFSAsyncHandle">GnomeVFSAsyncHandle</link> **handle_return,

1350

<indexterm zone="gnome-vfs-async-get-file-info"><primary>gnome_vfs_async_get_file_info</primary></indexterm>

1351

<programlisting><link linkend="void">void</link> gnome_vfs_async_get_file_info (<link linkend="GnomeVFSAsyncHandle">GnomeVFSAsyncHandle</link> **handle_return,

1312

1352

1313

1353

1314

1354

1331

1371

of the get_file_info operation.

1332

1372

</simpara></listitem></varlistentry>

1333

1373

<varlistentry><term><parameter>priority</parameter> :</term>

1334

<listitem><simpara> a value from <link linkend="GNOME-VFS-PRIORITY-MIN--CAPS"><literal>GNOME_VFS_PRIORITY_MIN</literal></link> to <link linkend="GNOME-VFS-PRIORITY-MAX--CAPS"><literal>GNOME_VFS_PRIORITY_MAX</literal></link> (normally

1335

should be <link linkend="GNOME-VFS-PRIORITY-DEFAULT--CAPS"><literal>GNOME_VFS_PRIORITY_DEFAULT</literal></link>) indicating the priority to assign this job

1374

<listitem><simpara> a value from <link linkend="GNOME-VFS-PRIORITY-MIN:CAPS"><literal>GNOME_VFS_PRIORITY_MIN</literal></link> to <link linkend="GNOME-VFS-PRIORITY-MAX:CAPS"><literal>GNOME_VFS_PRIORITY_MAX</literal></link> (normally

1375

should be <link linkend="GNOME-VFS-PRIORITY-DEFAULT:CAPS"><literal>GNOME_VFS_PRIORITY_DEFAULT</literal></link>) indicating the priority to assign this job

1336

1376

in allocating threads from the thread pool.

1337

1377

</simpara></listitem></varlistentry>

1338

1378

<varlistentry><term><parameter>callback</parameter> :</term>

1344

1384

</variablelist></refsect2>

1345

1385

1346

1386

<title>gnome_vfs_async_set_file_info ()</title>

1347

<indexterm zone="gnome-vfs-async-set-file-info"><primary sortas="gnome_vfs_async_set_file_info">gnome_vfs_async_set_file_info</primary></indexterm><programlisting><link linkend="void">void</link> gnome_vfs_async_set_file_info (<link linkend="GnomeVFSAsyncHandle">GnomeVFSAsyncHandle</link> **handle_return,

1387

<indexterm zone="gnome-vfs-async-set-file-info"><primary>gnome_vfs_async_set_file_info</primary></indexterm>

1388

<programlisting><link linkend="void">void</link> gnome_vfs_async_set_file_info (<link linkend="GnomeVFSAsyncHandle">GnomeVFSAsyncHandle</link> **handle_return,

1348

1389

1349

1390

1350

1391

1375

1416

of the set_file_info operation.

1376

1417

</simpara></listitem></varlistentry>

1377

1418

<varlistentry><term><parameter>priority</parameter> :</term>

1378

<listitem><simpara> a value from <link linkend="GNOME-VFS-PRIORITY-MIN--CAPS"><literal>GNOME_VFS_PRIORITY_MIN</literal></link> to <link linkend="GNOME-VFS-PRIORITY-MAX--CAPS"><literal>GNOME_VFS_PRIORITY_MAX</literal></link> (normally

1379

should be <link linkend="GNOME-VFS-PRIORITY-DEFAULT--CAPS"><literal>GNOME_VFS_PRIORITY_DEFAULT</literal></link>) indicating the priority to assign this job

1419

<listitem><simpara> a value from <link linkend="GNOME-VFS-PRIORITY-MIN:CAPS"><literal>GNOME_VFS_PRIORITY_MIN</literal></link> to <link linkend="GNOME-VFS-PRIORITY-MAX:CAPS"><literal>GNOME_VFS_PRIORITY_MAX</literal></link> (normally

1420

should be <link linkend="GNOME-VFS-PRIORITY-DEFAULT:CAPS"><literal>GNOME_VFS_PRIORITY_DEFAULT</literal></link>) indicating the priority to assign this job

1380

1421

in allocating threads from the thread pool.

1381

1422

</simpara></listitem></varlistentry>

1382

1423

<varlistentry><term><parameter>callback</parameter> :</term>

1388

1429

</variablelist></refsect2>

1389

1430

1390

1431

<title>gnome_vfs_async_load_directory ()</title>

1391

<indexterm zone="gnome-vfs-async-load-directory"><primary sortas="gnome_vfs_async_load_directory">gnome_vfs_async_load_directory</primary></indexterm><programlisting><link linkend="void">void</link> gnome_vfs_async_load_directory (<link linkend="GnomeVFSAsyncHandle">GnomeVFSAsyncHandle</link> **handle_return,

1432

<indexterm zone="gnome-vfs-async-load-directory"><primary>gnome_vfs_async_load_directory</primary></indexterm>

1433

<programlisting><link linkend="void">void</link> gnome_vfs_async_load_directory (<link linkend="GnomeVFSAsyncHandle">GnomeVFSAsyncHandle</link> **handle_return,

1392

1434

const <link linkend="gchar">gchar</link> *text_uri,

1393

1435

1394

1436

1416

1458

<listitem><simpara> number of files to process in a row before calling <parameter>callback</parameter>

1417

1459

</simpara></listitem></varlistentry>

1418

1460

<varlistentry><term><parameter>priority</parameter> :</term>

1419

<listitem><simpara> a value from <link linkend="GNOME-VFS-PRIORITY-MIN--CAPS"><literal>GNOME_VFS_PRIORITY_MIN</literal></link> to <link linkend="GNOME-VFS-PRIORITY-MAX--CAPS"><literal>GNOME_VFS_PRIORITY_MAX</literal></link> (normally

1420

should be <link linkend="GNOME-VFS-PRIORITY-DEFAULT--CAPS"><literal>GNOME_VFS_PRIORITY_DEFAULT</literal></link>) indicating the priority to assign to this job

1461

<listitem><simpara> a value from <link linkend="GNOME-VFS-PRIORITY-MIN:CAPS"><literal>GNOME_VFS_PRIORITY_MIN</literal></link> to <link linkend="GNOME-VFS-PRIORITY-MAX:CAPS"><literal>GNOME_VFS_PRIORITY_MAX</literal></link> (normally

1462

should be <link linkend="GNOME-VFS-PRIORITY-DEFAULT:CAPS"><literal>GNOME_VFS_PRIORITY_DEFAULT</literal></link>) indicating the priority to assign to this job

1421

1463

in allocating threads from the thread pool.

1422

1464

</simpara></listitem></varlistentry>

1423

1465

<varlistentry><term><parameter>callback</parameter> :</term>

1429

1471

</variablelist></refsect2>

1430

1472

1431

1473

<title>gnome_vfs_async_load_directory_uri ()</title>

1432

<indexterm zone="gnome-vfs-async-load-directory-uri"><primary sortas="gnome_vfs_async_load_directory_uri">gnome_vfs_async_load_directory_uri</primary></indexterm><programlisting><link linkend="void">void</link> gnome_vfs_async_load_directory_uri (<link linkend="GnomeVFSAsyncHandle">GnomeVFSAsyncHandle</link> **handle_return,

1474

<indexterm zone="gnome-vfs-async-load-directory-uri"><primary>gnome_vfs_async_load_directory_uri</primary></indexterm>

1475

<programlisting><link linkend="void">void</link> gnome_vfs_async_load_directory_uri (<link linkend="GnomeVFSAsyncHandle">GnomeVFSAsyncHandle</link> **handle_return,

1433

1476

1434

1477

1435

1478

1457

1500

<listitem><simpara> number of files to process in a row before calling <parameter>callback</parameter>

1458

1501

</simpara></listitem></varlistentry>

1459

1502

<varlistentry><term><parameter>priority</parameter> :</term>

1460

<listitem><simpara> a value from <link linkend="GNOME-VFS-PRIORITY-MIN--CAPS"><literal>GNOME_VFS_PRIORITY_MIN</literal></link> to <link linkend="GNOME-VFS-PRIORITY-MAX--CAPS"><literal>GNOME_VFS_PRIORITY_MAX</literal></link> (normally

1461

should be <link linkend="GNOME-VFS-PRIORITY-DEFAULT--CAPS"><literal>GNOME_VFS_PRIORITY_DEFAULT</literal></link>) indicating the priority to assign this job

1503

<listitem><simpara> a value from <link linkend="GNOME-VFS-PRIORITY-MIN:CAPS"><literal>GNOME_VFS_PRIORITY_MIN</literal></link> to <link linkend="GNOME-VFS-PRIORITY-MAX:CAPS"><literal>GNOME_VFS_PRIORITY_MAX</literal></link> (normally

1504

should be <link linkend="GNOME-VFS-PRIORITY-DEFAULT:CAPS"><literal>GNOME_VFS_PRIORITY_DEFAULT</literal></link>) indicating the priority to assign this job

1462

1505

in allocating threads from the thread pool.

1463

1506

</simpara></listitem></varlistentry>

1464

1507

<varlistentry><term><parameter>callback</parameter> :</term>

1470

1513

</variablelist></refsect2>

1471

1514

1472

1515

<title>gnome_vfs_async_xfer ()</title>

1473

<indexterm zone="gnome-vfs-async-xfer"><primary sortas="gnome_vfs_async_xfer">gnome_vfs_async_xfer</primary></indexterm><programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link> gnome_vfs_async_xfer (<link linkend="GnomeVFSAsyncHandle">GnomeVFSAsyncHandle</link> **handle_return,

1516

<indexterm zone="gnome-vfs-async-xfer"><primary>gnome_vfs_async_xfer</primary></indexterm>

1517

<programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link> gnome_vfs_async_xfer (<link linkend="GnomeVFSAsyncHandle">GnomeVFSAsyncHandle</link> **handle_return,

1474

1518

1475

1519

1476

1520

1506

1550

If you use both <parameter>progress_update_callback</parameter> and <parameter>progress_sync_callback</parameter>,

1507

1551

the <parameter>progress_sync_callback</parameter> will always be invoked before the

1508

1552

<parameter>progress_update_callback</parameter>. It is recommended to do conflict

1509

handling in <parameter>progress_update_callback</parameter>, and always return <link linkend="TRUE--CAPS"><literal>TRUE</literal></link>

1553

handling in <parameter>progress_update_callback</parameter>, and always return <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>

1510

1554

in <parameter>progress_sync_callback</parameter>, because if the Xfer's

1511

1555

1512

1556

<parameter>progress_update_callback</parameter> will only be invoked if it hasn't

1513

1557

been invoked within the last 100 milliseconds, and if

1514

1558

<parameter>progress_update_callback</parameter> is not invoked, only

1515

1559

<parameter>progress_sync_callback</parameter> is authoritative for the

1516

further processing, causing abortion if it is <link linkend="FALSE--CAPS"><literal>FALSE</literal></link>.

1560

further processing, causing abortion if it is <link linkend="FALSE:CAPS"><literal>FALSE</literal></link>.

1517

1561

</para>

1518

1562

</note></para>

1519

1563

<para>

1522

1566

<listitem><simpara> when the function returns, will point to a handle for the operation.

1523

1567

</simpara></listitem></varlistentry>

1524

1568

<varlistentry><term><parameter>source_uri_list</parameter> :</term>

1525

<listitem><simpara> A <link linkend="GList"><type>GList</type></link> of source <link linkend="GnomeVFSURIs"><type>GnomeVFSURIs</type></link>.

1569

<listitem><simpara> A <link linkend="GList"><type>GList</type></link> of source <link linkend="GnomeVFSURIs."><type>GnomeVFSURIs.</type></link>

1526

1570

</simpara></listitem></varlistentry>

1527

1571

<varlistentry><term><parameter>target_uri_list</parameter> :</term>

1528

1572

<listitem><simpara> A <link linkend="GList"><type>GList</type></link> of target <link linkend="GnomeVFSURIs"><type>GnomeVFSURIs</type></link>, each corresponding to one URI in

1538

1582

<listitem><simpara> A <link linkend="GnomeVFSOverwriteMode"><type>GnomeVFSOverwriteMode</type></link> specifying how to proceed if a file is being overwritten.

1539

1583

</simpara></listitem></varlistentry>

1540

1584

<varlistentry><term><parameter>priority</parameter> :</term>

1541

<listitem><simpara> A value from <link linkend="GNOME-VFS-PRIORITY-MIN--CAPS"><literal>GNOME_VFS_PRIORITY_MIN</literal></link> to <link linkend="GNOME-VFS-PRIORITY-MAX--CAPS"><literal>GNOME_VFS_PRIORITY_MAX</literal></link> (normally

1542

should be <link linkend="GNOME-VFS-PRIORITY-DEFAULT--CAPS"><literal>GNOME_VFS_PRIORITY_DEFAULT</literal></link>) indicating the priority to assign this job

1585

<listitem><simpara> A value from <link linkend="GNOME-VFS-PRIORITY-MIN:CAPS"><literal>GNOME_VFS_PRIORITY_MIN</literal></link> to <link linkend="GNOME-VFS-PRIORITY-MAX:CAPS"><literal>GNOME_VFS_PRIORITY_MAX</literal></link> (normally

1586

should be <link linkend="GNOME-VFS-PRIORITY-DEFAULT:CAPS"><literal>GNOME_VFS_PRIORITY_DEFAULT</literal></link>) indicating the priority to assign this job

1543

1587

in allocating threads from the thread pool.

1544

1588

</simpara></listitem></varlistentry>

1545

1589

<varlistentry><term><parameter>progress_update_callback</parameter> :</term>

1556

1600

<varlistentry><term><parameter>sync_callback_data</parameter> :</term>

1557

1601

<listitem><simpara> User data to pass to <parameter>progress_sync_callback</parameter>.

1558

1602

</simpara></listitem></varlistentry>

1559

<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="GNOME-VFS-OK--CAPS"><literal>GNOME_VFS_OK</literal></link> if the paramaters were in order,

1560

or <link linkend="GNOME-VFS-ERROR-BAD-PARAMETERS--CAPS"><literal>GNOME_VFS_ERROR_BAD_PARAMETERS</literal></link> if something was wrong in the passed in arguments.

1603

<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="GNOME-VFS-OK:CAPS"><literal>GNOME_VFS_OK</literal></link> if the paramaters were in order,

1604

or <link linkend="GNOME-VFS-ERROR-BAD-PARAMETERS:CAPS"><literal>GNOME_VFS_ERROR_BAD_PARAMETERS</literal></link> if something was wrong in the passed in arguments.

1561

1605

</simpara></listitem></varlistentry>

1562

1606

</variablelist></refsect2>

1563

1607

1564

1608

<title>gnome_vfs_async_find_directory ()</title>

1565

<indexterm zone="gnome-vfs-async-find-directory"><primary sortas="gnome_vfs_async_find_directory">gnome_vfs_async_find_directory</primary></indexterm><programlisting><link linkend="void">void</link> gnome_vfs_async_find_directory (<link linkend="GnomeVFSAsyncHandle">GnomeVFSAsyncHandle</link> **handle_return,

1609

<indexterm zone="gnome-vfs-async-find-directory"><primary>gnome_vfs_async_find_directory</primary></indexterm>

1610

<programlisting><link linkend="void">void</link> gnome_vfs_async_find_directory (<link linkend="GnomeVFSAsyncHandle">GnomeVFSAsyncHandle</link> **handle_return,

1566

1611

1567

1612

1568

1613

1612

1657

<listitem><simpara> if creating, use these permissions.

1613

1658

</simpara></listitem></varlistentry>

1614

1659

<varlistentry><term><parameter>priority</parameter> :</term>

1615

<listitem><simpara> a value from <link linkend="GNOME-VFS-PRIORITY-MIN--CAPS"><literal>GNOME_VFS_PRIORITY_MIN</literal></link> to <link linkend="GNOME-VFS-PRIORITY-MAX--CAPS"><literal>GNOME_VFS_PRIORITY_MAX</literal></link> (normally

1616

should be <link linkend="GNOME-VFS-PRIORITY-DEFAULT--CAPS"><literal>GNOME_VFS_PRIORITY_DEFAULT</literal></link>) indicating the priority to assign to this job

1660

<listitem><simpara> a value from <link linkend="GNOME-VFS-PRIORITY-MIN:CAPS"><literal>GNOME_VFS_PRIORITY_MIN</literal></link> to <link linkend="GNOME-VFS-PRIORITY-MAX:CAPS"><literal>GNOME_VFS_PRIORITY_MAX</literal></link> (normally

1661

should be <link linkend="GNOME-VFS-PRIORITY-DEFAULT:CAPS"><literal>GNOME_VFS_PRIORITY_DEFAULT</literal></link>) indicating the priority to assign to this job

1617

1662

in allocating threads from the thread pool.

1618

1663

</simpara></listitem></varlistentry>

1619

1664

<varlistentry><term><parameter>callback</parameter> :</term>

1625

1670

</variablelist></refsect2>

1626

1671

1627

1672

<title>gnome_vfs_async_file_control ()</title>

1628

<indexterm zone="gnome-vfs-async-file-control" role="2.2"><primary sortas="gnome_vfs_async_file_control">gnome_vfs_async_file_control</primary></indexterm><programlisting><link linkend="void">void</link> gnome_vfs_async_file_control (<link linkend="GnomeVFSAsyncHandle">GnomeVFSAsyncHandle</link> *handle,

1673

<indexterm zone="gnome-vfs-async-file-control" role="2.2"><primary>gnome_vfs_async_file_control</primary></indexterm>

1674

<programlisting><link linkend="void">void</link> gnome_vfs_async_file_control (<link linkend="GnomeVFSAsyncHandle">GnomeVFSAsyncHandle</link> *handle,

1629

1675

const <link linkend="char">char</link> *operation,

1630

1676

1631

1677

1664

1710

</variablelist><para role="since">Since 2.2</para></refsect2>

1665

1711

1666

1712

<title>gnome_vfs_find_directory_result_dup ()</title>

1667

<indexterm zone="gnome-vfs-find-directory-result-dup" role="2.12"><primary sortas="gnome_vfs_find_directory_result_dup">gnome_vfs_find_directory_result_dup</primary></indexterm><programlisting><link linkend="GnomeVFSFindDirectoryResult">GnomeVFSFindDirectoryResult</link>* gnome_vfs_find_directory_result_dup

1713

<indexterm zone="gnome-vfs-find-directory-result-dup" role="2.12"><primary>gnome_vfs_find_directory_result_dup</primary></indexterm>

1714

<programlisting><link linkend="GnomeVFSFindDirectoryResult">GnomeVFSFindDirectoryResult</link>* gnome_vfs_find_directory_result_dup

1668

1715

(<link linkend="GnomeVFSFindDirectoryResult">GnomeVFSFindDirectoryResult</link> *result);</programlisting>

1669

1716

<para>

1670

1717

Duplicates <parameter>result</parameter>.

1675

1722

<para>

1676

1723

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

1677

1724

<varlistentry><term><parameter>result</parameter> :</term>

1678

<listitem><simpara> a <link linkend="GnomeVFSFindDirectoryResult"><type>GnomeVFSFindDirectoryResult</type></link>.

1725

<listitem><simpara> a <link linkend="GnomeVFSFindDirectoryResult."><type>GnomeVFSFindDirectoryResult.</type></link>

1679

1726

</simpara></listitem></varlistentry>

1680

1727

<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A 1:1 copy of <parameter>result</parameter>.

1681

1728

1683

1730

</variablelist><para role="since">Since 2.12</para></refsect2>

1684

1731

1685

1732

<title>gnome_vfs_find_directory_result_free ()</title>

1686

<indexterm zone="gnome-vfs-find-directory-result-free" role="2.12"><primary sortas="gnome_vfs_find_directory_result_free">gnome_vfs_find_directory_result_free</primary></indexterm><programlisting><link linkend="void">void</link> gnome_vfs_find_directory_result_free

1733

<indexterm zone="gnome-vfs-find-directory-result-free" role="2.12"><primary>gnome_vfs_find_directory_result_free</primary></indexterm>

1734

<programlisting><link linkend="void">void</link> gnome_vfs_find_directory_result_free

1687

1735

(<link linkend="GnomeVFSFindDirectoryResult">GnomeVFSFindDirectoryResult</link> *result);</programlisting>

1688

1736

<para>

1689

1737

Unrefs the inner uri object and frees the memory

1691

1739

<para>

1692

1740

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

1693

1741

<varlistentry><term><parameter>result</parameter> :</term>

1694

<listitem><simpara> a <link linkend="GnomeVFSFindDirectoryResult"><type>GnomeVFSFindDirectoryResult</type></link>.

1742

<listitem><simpara> a <link linkend="GnomeVFSFindDirectoryResult."><type>GnomeVFSFindDirectoryResult.</type></link>

1695

1743

</simpara></listitem></varlistentry>

1696

1744

</variablelist><para role="since">Since 2.12</para></refsect2>

1697

1745