PD Layer: PDFolder

PDFolder Typedefs

PDFolder

Header: PDExpT.h:7088

Description

An opaque object representing a collection folder dictionary. Folders are used to provide grouping for files in a portable collection.

Syntax

typedef OPAQUE_64_BITS PDFolder;

Returned From

Used By

PDFolder Functions

PDFolderGetCreationDate: - Gets the creation date of the folder.
PDFolderGetDescription: - Gets the description of the folder.
PDFolderGetDescriptionStyled: - Gets the description of the folder as styled text, in XML Text Layout Format.
PDFolderGetFieldDate: - Gets the value of the specified date field in the folder.
PDFolderGetFieldNumber: - Gets the value of the specified numeric field in the folder.
PDFolderGetFieldStyle: - Gets the style dictionary for the specified field in the folder
PDFolderGetFieldStyledText: - Gets the value of the specified text field in the folder as styled text, in XML Text Layout Format.
PDFolderGetFieldText: - Gets the value of the specified text field in the folder.
PDFolderGetFirstChild: - Gets the first child of a folder.
PDFolderGetID: - Gets the ID number of a folder.
PDFolderGetModDate: - Gets the modification date of the folder.
PDFolderGetName: - Gets the name of a folder.
PDFolderGetNextSibling: - Gets the next sibling of a folder.
PDFolderGetParent: - Gets the parent of the specified folder.
PDFolderGetPathText: - Gets the path of the folder.
PDFolderIsValid: - Determines if a PDFolder is valid.
PDFolderSetCreationDate: - Sets the creation date of the folder.
PDFolderSetDescription: - Sets the description of the folder.
PDFolderSetDescriptionStyled: - Sets the description of the folder using styled text.
PDFolderSetFieldDate: - Sets the specified date field in the folder.
PDFolderSetFieldNumber: - Sets the specified numeric field in the folder.
PDFolderSetFieldStyle: - Sets the style dictionary for the specified field in the folder.
PDFolderSetFieldStyledText: - Sets the specified text field in the folder
PDFolderSetFieldText: - Sets the specified text field in the folder.
PDFolderSetModDate: - Sets the modification date of the folder.
PDFolderSetName: - Sets the name of a folder.
PDFolderSetParent: - Sets the parent of the specified folder.

PDFolderGetCreationDate

Header: PDProcs.h:12589

Description

Gets the creation date of the folder.

Syntax

ASBool PDFolderGetCreationDate(PDFolder folder, ASTimeRec *date);

Parameters

`folder`	The folder.
`date`	A pointer to an `ASTimeRec` that will be filled with the folder creation date.

Returns

true if the folder has a creation date, false otherwise.

PDFolderGetDescription

Header: PDProcs.h:12602

Description

Gets the description of the folder.

Syntax

ASBool PDFolderGetDescription(PDFolder folder, ASText text);

Parameters

`folder`	The folder.
`text`	A text object that will receive the folder description.

Returns

true if the folder has a description, false otherwise.

PDFolderGetDescriptionStyled

Header: PDProcs.h:12609

Description

Gets the description of the folder as styled text, in XML Text Layout Format.

Syntax

ASBool PDFolderGetDescriptionStyled(PDFolder folder, ASText text);

Parameters

`folder`	The folder.
`text`	A text object that will receive the folder description.

Returns

true if the folder has a description, false otherwise.

PDFolderGetFieldDate

Header: PDProcs.h:12698

Description

Gets the value of the specified date field in the folder.

Syntax

ASBool PDFolderGetFieldDate(PDFolder folder, ASAtom fieldID, ASTimeRec *date);

Parameters

`folder`	The folder.
`fieldID`	The field identifier.
`date`	The date that will receive the field value

Returns

true if the field value was found, false otherwise.

PDFolderGetFieldNumber

Header: PDProcs.h:12681

Description

Gets the value of the specified numeric field in the folder.

Syntax

ASBool PDFolderGetFieldNumber(PDFolder folder, ASAtom fieldID, float *number);

Parameters

`folder`	The folder.
`fieldID`	The field identifier.
`number`	The number that will receive the field value.

Returns

true if the field value was found, false otherwise.

PDFolderGetFieldStyle

Header: PDProcs.h:12673

Description

Gets the style dictionary for the specified field in the folder

Syntax

ASBool PDFolderGetFieldStyle(PDFolder folder, ASAtom fieldID, ASCab styles);

Parameters

`folder`	The folder.
`fieldID`	The field identifier.
`styles`	ASCab object that will receive the field styles

Returns

true if the field value was found, false otherwise.

PDFolderGetFieldStyledText

Header: PDProcs.h:12656

Description

Gets the value of the specified text field in the folder as styled text, in XML Text Layout Format.

Syntax

ASBool PDFolderGetFieldStyledText(PDFolder attachment, ASAtom fieldID, ASText text);

Parameters

`folder`	The folder.
`fieldID`	The field identifier.
`text`	The text object that will receive the field value.

Returns

true if the field value was found, false otherwise.

PDFolderGetFieldText

Header: PDProcs.h:12630

Description

Gets the value of the specified text field in the folder.

Syntax

ASBool PDFolderGetFieldText(PDFolder folder, ASAtom fieldID, ASText text);

Parameters

`folder`	The folder.
`fieldID`	The field identifier.
`text`	The text object that will receive the field value.

Returns

true if the field value was found, false otherwise.

PDFolderGetFirstChild

Header: PDProcs.h:12539

Description

Gets the first child of a folder.

Syntax

PDFolder PDFolderGetFirstChild(PDFolder folder);

Parameters

folder

The folder.

Returns

The first child of the folder. If no child exists, the returned folder is invalid.

PDFolderGetID

Header: PDProcs.h:12563

Description

Gets the ID number of a folder.

Syntax

ASInt32 PDFolderGetID(PDFolder folder);

Parameters

folder

The folder.

Returns

The folder ID.

PDFolderGetModDate

Header: PDProcs.h:12576

Description

Gets the modification date of the folder.

Syntax

ASBool PDFolderGetModDate(PDFolder folder, ASTimeRec *date);

Parameters

`folder`	The folder.
`date`	A pointer to an `ASTimeRec` that will be filled with the folder modification date.

Returns

true if the folder has a modification date, false otherwise.

PDFolderGetName

Header: PDProcs.h:12557

Description

Gets the name of a folder.

Syntax

void PDFolderGetName(PDFolder folder, ASText name);

Parameters

`folder`	The folder.
`folderName`	The name of the folder.

PDFolderGetNextSibling

Header: PDProcs.h:12545

Description

Gets the next sibling of a folder.

Syntax

PDFolder PDFolderGetNextSibling(PDFolder folder);

Parameters

folder

The folder.

Returns

The next sibling of the folder. If no next sibling exists, the returned folder is invalid.

PDFolderGetParent

Header: PDProcs.h:12527

Description

Gets the parent of the specified folder.

Syntax

PDFolder PDFolderGetParent(PDFolder folder);

Parameters

folder

The folder object.

Returns

The parent of the specified folder. If no parent exists, the returned folder is invalid.

PDFolderGetPathText

Header: PDProcs.h:12569

Description

Gets the path of the folder.

Syntax

void PDFolderGetPathText(PDFolder folder, ASText path);

Parameters

`folder`	The folder.
`path`	The folder path.

PDFolderIsValid

Header: PDProcs.h:12469

Description

Determines if a PDFolder is valid.

Syntax

ASBool PDFolderIsValid(PDFolder folder);

Parameters

folder

The folder object

Returns

true if the folder is a dictionary, false otherwise.

PDFolderSetCreationDate

Header: PDProcs.h:12595

Description

Sets the creation date of the folder.

Syntax

void PDFolderSetCreationDate(PDFolder folder, const ASTimeRec *date);

Parameters

`folder`	The folder.
`date`	A pointer to an `ASTimeRec` will be used to set the creation date.

PDFolderSetDescription

Header: PDProcs.h:12615

Description

Sets the description of the folder. Removes a styled version if present.

Syntax

void PDFolderSetDescription(PDFolder folder, ASConstText text);

Parameters

`folder`	The folder.
`text`	The new description for the folder.

PDFolderSetDescriptionStyled

Header: PDProcs.h:12622

Description

Sets the description of the folder using styled text. Keeps the non-styled description in sync. with the styled version.

Syntax

void PDFolderSetDescriptionStyled(PDFolder folder, ASConstText text);

Parameters

`folder`	The folder.
`text`	The new description for the folder in XML Text Layout Format.

PDFolderSetFieldDate

Header: PDProcs.h:12707

Description

Sets the specified date field in the folder.

Syntax

void PDFolderSetFieldDate(PDFolder folder, ASAtom fieldID, const ASTimeRec *date);

Parameters

`folder`	The folder.
`fieldID`	The field identifier.
`date`	The date to use as the new value for the specified field.

Exceptions

genErrBadParm

is raised if the field does not exist in the collection schema or the field type is not D (date).

PDFolderSetFieldNumber

Header: PDProcs.h:12690

Description

Sets the specified numeric field in the folder.

Syntax

void PDFolderSetFieldNumber(PDFolder folder, ASAtom fieldID, float number);

Parameters

`folder`	The folder.
`fieldID`	The field identifier.
`number`	The number to use as the new value for the specified field.

Exceptions

genErrBadParm

is raised if the field does not exist in the collection schema or the field type is not N (number).

PDFolderSetFieldStyle

Header: PDProcs.h:12665

Description

Sets the style dictionary for the specified field in the folder.

Syntax

void PDFolderSetFieldStyle(PDFolder folder, ASAtom fieldID, ASConstCab styles);

Parameters

`folder`	The folder.
`fieldID`	The field identifier.
`styles`	ASConstCab containing field styles for the specified field.

Exceptions

genErrBadParm

is raised if the field does not exist in the collection schema or the field type is not S (text).

PDFolderSetFieldStyledText

Header: PDProcs.h:12648

Description

Sets the specified text field in the folder

Syntax

void PDFolderSetFieldStyledText(PDFolder folder, ASAtom fieldID, ASConstText text);

Parameters

`folder`	The folder.
`fieldID`	The field identifier.
`text`	Text Layout Format XML containing the text to use as the new value for the specified field.

Exceptions

genErrBadParm

is raised if the field does not exist in the collection schema or the field type is not S (text).

PDFolderSetFieldText

Header: PDProcs.h:12639

Description

Sets the specified text field in the folder.

Syntax

void PDFolderSetFieldText(PDFolder folder, ASAtom fieldID, ASConstText text);

Parameters

`folder`	The folder.
`fieldID`	The field identifier.
`text`	The text to use as the new value for the specified field.

Exceptions

genErrBadParm

is raised if the field does not exist in the collection schema or the field type is not S (text).

PDFolderSetModDate

Header: PDProcs.h:12582

Description

Sets the modification date of the folder.

Syntax

void PDFolderSetModDate(PDFolder folder, const ASTimeRec *date);

Parameters

`folder`	The folder.
`date`	A pointer to an `ASTimeRec` that will be used to set the modification date.

PDFolderSetName

Header: PDProcs.h:12551

Description

Sets the name of a folder.

Syntax

void PDFolderSetName(PDFolder folder, ASConstText folderName);

Parameters

`folder`	The folder.
`folderName`	The name of the folder.

PDFolderSetParent

Header: PDProcs.h:12533

Description

Sets the parent of the specified folder.

Syntax

void PDFolderSetParent(PDFolder folder, PDFolder parent);

Parameters

`folder`	The folder that will receive a new parent.
`parent`	The new parent folder.