a1200   NEWS   APPS   DOCS   ABOUT
a1200
----
a1200
----
Autodocs
 Libraries:
 aml.library
  --rexxhost--
  AddArticlePartA
  AddCustomField
  AddFolderArticle
  CreateAddressEntryA
  CreateArticleA
  CreateArticlePartA
  CreateDecoderA
  CreateFolderA
  CreateServerA
  Decode
  DisposeAddressEntry
  DisposeArticle
  DisposeArticlePart
  DisposeDecoder
  DisposeFolder
  DisposeServer
  Encode
  ExpungeFolder
  FindAddressEntryA
  GetAddressEntryAttrsA
  GetArticleAttrsA
  GetArticlePartDataA
  GetCustomFieldData
  GetDecoderAttrsA
  GetFolderAttrsA
  GetServerArticles
  GetServerAttrsA
  GetServerHeaders
  HuntAddressEntryA
  OpenAddressEntry
  OpenArticle
  OpenFolderA
  ReadFolderSpool
  RemAddressEntry
  RemCustomField
  RemFolder
  RemFolderArticle
  SaveAddressEntry
  SaveFolder
  ScanFolderIndex
  SendArticle
  SetAddressEntryAttrsA
  SetArticleAttrsA
  SetArticlePartDataA
  SetDecoderAttrsA
  SetFolderAttrsA
  SetServerAttrsA
  WriteFolderSpool
Include
GuruMeditation
Docs » Autodocs » aml.library » ExpungeFolder

NAME

	ExpungeFolder -- Deletes a folder and its contents.

SYNOPSIS

	value = ExpungeFolder(folder, trash, hook)
	D0					A0	 A1	  A2
	LONG ExpungeFolder(APTR folder, APTR trash, struct Hook *hook);

FUNCTION

	This function will delete the entire contents of the
	specified folder, including indexing and folder information.
	The provided hook will be called for each article item
	deleted, to allow for progress displays and such.  If the trash
	argument is provided, it must be a pointer to another folder
	object to act as a Trash folder, in which the "deleted"
	articles will be placed.

INPUTS

	folder - Pointer to a folder object
	trash - Optional pointer to a folder object to
		act as trash
	hook - Pointer to a hook, data is a struct FolderIndex pointer.

RESULT

	value - The number of articles deleted from the folder.

Comments

Name:
E-mail: Use this if you want a message if you get a response, will not be shown.
Comment:
Select correct short for:

Sanity

SNT
PDX
AYS
PHA

Comments:
$VER: d0.se 1.14 Copyright © 2011-2024 Tobias Geijersson support at d0 dot se