LayerAV_Layer
ObjectDirectory_Services

Diirectory information service object.



Define Summary
 Define
 ATTR_DirCertificates
 ATTR_DirEmail
 ATTR_DirFirstName
 ATTR_DirFullName
 ATTR_DirLastName
 ATTR_DirPrefEncryptionCert
 kDirDirectoryTooLargeToList
Retrieve all entries in the specified groups. If that would take too long, return kDirDirectoryTooLargeToList. This may be used in the user interface to immediately display the contents of a small directory or group, so responsiveness is important.
 kSecError
 kSecFalse
 kSecOk
 kSecTrue
 PROP_DirectoryInfo_DirHandlerID
 PROP_DirectoryInfo_DirType
 PROP_DirectoryInfo_ID
 PROP_DirectoryInfo_Name
 PROP_DirectoryInfo_Version
Typedef Summary
 Typedef
 DirAttributes
A directory attribute collection is used to set output options of a directory connection.
 DirConnection
 DirConnectionHandler
 DirConnectionRec
 DirectoryInfo
A directory information structure contains configuration settings used to establish a connection to a directory. Common top-level properties are defined below. Note that the prefix DirStdEntry_ is reserved for standard entries and should not be used for entries specific to a particular directory. Optionally, this could contain other configuration information specific to the directory.
 DirectoryList
A directory information list ASCab contains a vector of nested DirectoryInfo ASCab objects, one for every directory contained within the engine. Each directory ASCab contains a user interface name as an ASText and a unique ID as an ASAtom.
 DirGroupList
Group names are represented as text in an ASCab. For example:
 DirResults
Search and enumeration results are represented as a two-dimensional ASCab where each "row" is itself an ASCab that contains attributes defined by SetOutputOptions calls.
 DirSearchCriteria
Directory search criteria are represented as a set of key/value pairs where the keys are attribute names and the values are search strings applied to those attributes. A logical "AND" is implied when multiple search criteria are present. Unrecognized search criteria are ignored.
 SecErrorInfo
 SecErrorInfoRec
 SecRetCode
Error handling
Structure Summary
 Structure
 _t_DirConnection
A directory connection object structure.
 _t_SecErrorInfo
If a function returns -1 or less, you can call a GetLastError appropriate to the context and retrieve information about the last error. That call may return NULL which basically means "Unknown Error". Note that in the presence of threads, the error information may become inaccurate.
Callback Summary
 Callback
 DirConnection_close
Closes the specified directory connection.
 DirConnection_customSearch
 DirConnection_customUISearch
Pops up a custom user interface that allows the user to set search criteria and execute the search.
 DirConnection_getDirInfo
Retrieves information about the directory associated with the connection.
 DirConnection_getGroups
Retrieves the list of groups that this connection supports.
 DirConnection_getLastError
Retrieves information about the last error that occurred in the specified connection.
 DirConnection_list
TBD
 DirConnection_setCustomOutputOptions
TBD
 DirConnection_setStandardOutputOptions
Special case: The ATTR_Certificates attribute is intended to encompass all certificate attributes a directory might have. If ATTR_Certificates is requested, it may have to be translated into several attributes depending on the directory.
 DirConnection_standardSearch
TBD
Defines Detail
ATTR_DirCertificates 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define ATTR_DirCertificates "certificates"

File: DirectoryHFT.h
Line: 152
ATTR_DirEmail 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define ATTR_DirEmail "email"

File: DirectoryHFT.h
Line: 151
ATTR_DirFirstName 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define ATTR_DirFirstName "firstName"

File: DirectoryHFT.h
Line: 148
ATTR_DirFullName 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define ATTR_DirFullName "fullName"

File: DirectoryHFT.h
Line: 150
ATTR_DirLastName 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define ATTR_DirLastName "lastName"

File: DirectoryHFT.h
Line: 149
ATTR_DirPrefEncryptionCert 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define ATTR_DirPrefEncryptionCert "defaultEncryptCert"

File: DirectoryHFT.h
Line: 155
kDirDirectoryTooLargeToList 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kDirDirectoryTooLargeToList 2

Description

Retrieve all entries in the specified groups. If that would take too long, return kDirDirectoryTooLargeToList. This may be used in the user interface to immediately display the contents of a small directory or group, so responsiveness is important.


File: DirectoryHFT.h
Line: 313
kSecError 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kSecError -1

File: DirectoryHFT.h
Line: 44
kSecFalse 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kSecFalse 0

File: DirectoryHFT.h
Line: 40
kSecOk 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kSecOk 1

File: DirectoryHFT.h
Line: 42
kSecTrue 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kSecTrue 1

File: DirectoryHFT.h
Line: 38
PROP_DirectoryInfo_DirHandlerID 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PROP_DirectoryInfo_DirHandlerID "dirStdEntryPrefDirHandlerID"

File: DirectoryHFT.h
Line: 124
PROP_DirectoryInfo_DirType 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PROP_DirectoryInfo_DirType "dirStdEntryDirType"

File: DirectoryHFT.h
Line: 131
PROP_DirectoryInfo_ID 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PROP_DirectoryInfo_ID "dirStdEntryID"

File: DirectoryHFT.h
Line: 116
PROP_DirectoryInfo_Name 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PROP_DirectoryInfo_Name "dirStdEntryName"

File: DirectoryHFT.h
Line: 111
PROP_DirectoryInfo_Version 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PROP_DirectoryInfo_Version "dirStdEntryVersion"

File: DirectoryHFT.h
Line: 136

Typedefs Detail
DirAttributes 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef ASCab DirAttributes;

A directory attribute collection is used to set output options of a directory connection.

The collection is represented in an ASCab as:

{ ("0", "nameOfAttribute1"), ("1", "nameOfAttribute2"), ... }


File: DirectoryHFT.h
Line: 187
DirConnection 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_DirConnection DirConnection;

File: DirectoryHFT.h
Line: 63
DirConnectionHandler 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_DirConnection DirConnectionHandler;

File: DirectoryHFT.h
Line: 375
DirConnectionRec 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_DirConnection DirConnectionRec;

File: DirectoryHFT.h
Line: 375
DirectoryInfo 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef ASCab DirectoryInfo;

A directory information structure contains configuration settings used to establish a connection to a directory. Common top-level properties are defined below. Note that the prefix DirStdEntry_ is reserved for standard entries and should not be used for entries specific to a particular directory. Optionally, this could contain other configuration information specific to the directory.


File: DirectoryHFT.h
Line: 105
DirectoryList 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef ASCab DirectoryList;

A directory information list ASCab contains a vector of nested DirectoryInfo ASCab objects, one for every directory contained within the engine. Each directory ASCab contains a user interface name as an ASText and a unique ID as an ASAtom.

See Also


File: PubSecHFT.h
Line: 1231
DirGroupList 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef ASCab DirGroupList;

Group names are represented as text in an ASCab. For example:

{ ("0", "friends"), ("1", "family"), ... }


File: DirectoryHFT.h
Line: 164
DirResults 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef ASCab DirResults;

Search and enumeration results are represented as a two-dimensional ASCab where each "row" is itself an ASCab that contains attributes defined by SetOutputOptions calls.


File: DirectoryHFT.h
Line: 254
DirSearchCriteria 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef ASCab DirSearchCriteria;

Directory search criteria are represented as a set of key/value pairs where the keys are attribute names and the values are search strings applied to those attributes. A logical "AND" is implied when multiple search criteria are present. Unrecognized search criteria are ignored.


File: DirectoryHFT.h
Line: 235
SecErrorInfo 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_SecErrorInfo SecErrorInfo;

File: DirectoryHFT.h
Line: 60
SecErrorInfoRec 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_SecErrorInfo SecErrorInfoRec;

File: DirectoryHFT.h
Line: 60
SecRetCode 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef ASInt32 SecRetCode;

File: DirectoryHFT.h
Line: 36


Structure Detail
_t_DirConnection
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_DirConnection {
 ASSize_t size; 
 
 void* clientData; 
 
 DirConnection_close close; 
 
 DirConnection_getLastError getLastError; 
 
 DirConnection_getDirInfo getDirInfo; 
 
 DirConnection_getGroups getGroups; 
 
 DirConnection_setStandardOutputOptions setStandardOutputOptions; 
 
 DirConnection_setCustomOutputOptions setCustomOutputOptions; 
 
 DirConnection_standardSearch standardSearch; 
 
 DirConnection_customSearch customSearch; 
 
 DirConnection_customUISearch customUISearch; 
 
 DirConnection_list list; 
}

A directory connection object structure.


File: DirectoryHFT.h
Line: 343

Elements
size  

The size of this data structure.

 
clientData  

The data to be passed in.

 
_t_SecErrorInfo 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_SecErrorInfo {
 ASSize_t size; 
 
 ASText text; 
 
 void* reserved; 
}

If a function returns -1 or less, you can call a GetLastError appropriate to the context and retrieve information about the last error. That call may return NULL which basically means "Unknown Error". Note that in the presence of threads, the error information may become inaccurate.


File: DirectoryHFT.h
Line: 52

Elements
size  

The size of this structure.

 
text  

The description of the error.

 
reserved  

Adobe use only. It must be set to NULL by external developers.

Callbacks Detail
DirConnection_close 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

void (*DirConnection_close)(DirConnection inConnection)

Closes the specified directory connection.


File: DirectoryHFT.h
Line: 324
DirConnection_customSearch 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

SecRetCode (*DirConnection_customSearch)(DirConnection inConnection, DirSearchCriteria inSearchCriteria, ASText inGroup, DirResults outResults)

File: DirectoryHFT.h
Line: 288
DirConnection_customUISearch 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

SecRetCode (*DirConnection_customUISearch)(DirConnection inConnection, ASText inGroup, DirResults outResults)

Pops up a custom user interface that allows the user to set search criteria and execute the search.


File: DirectoryHFT.h
Line: 301
DirConnection_getDirInfo 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

SecRetCode (*DirConnection_getDirInfo)(DirConnection inConnection, DirectoryInfo outDirInfo)

Retrieves information about the directory associated with the connection.


File: DirectoryHFT.h
Line: 332
DirConnection_getGroups 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

SecRetCode (*DirConnection_getGroups)(DirConnection inConnection, DirGroupList outGroupList)

Retrieves the list of groups that this connection supports.


File: DirectoryHFT.h
Line: 170
DirConnection_getLastError 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

SecErrorInfo (*DirConnection_getLastError)(DirConnection inConnection)

Retrieves information about the last error that occurred in the specified connection.


File: DirectoryHFT.h
Line: 338
DirConnection_list 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

SecRetCode (*DirConnection_list)(DirConnection inConnection, ASText inGroup, DirResults outResults)

TBD


File: DirectoryHFT.h
Line: 319
DirConnection_setCustomOutputOptions 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

SecRetCode (*DirConnection_setCustomOutputOptions)(DirConnection inConnection, DirAttributes inRequestedAttrs, DirAttributes outUnsupportedAttrs)

TBD


File: DirectoryHFT.h
Line: 215
DirConnection_setStandardOutputOptions 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

SecRetCode (*DirConnection_setStandardOutputOptions)(DirConnection inConnection, DirAttributes inRequestedAttrs, DirAttributes outUnsupportedAttrs)

Special case: The ATTR_Certificates attribute is intended to encompass all certificate attributes a directory might have. If ATTR_Certificates is requested, it may have to be translated into several attributes depending on the directory.


File: DirectoryHFT.h
Line: 203
DirConnection_standardSearch 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

SecRetCode (*DirConnection_standardSearch)(DirConnection inConnection, DirSearchCriteria inSearchCriteria, ASText inGroup, DirResults outResults)

TBD


File: DirectoryHFT.h
Line: 272