DL Logo

ASPlatformPath Typedefs

ASPlatformPath

Header: ASExpT.h:2172

Description

An ASPlatformPath and associated platform path types. This is an opaque object used to retrieve a platform path object. ASFileSysAcquirePlatformPath() allocates and initializes this object. ASPlatformPath * calls are used to access its contents. To discard this object, call ASFileSysReleasePlatformPath().

Syntax

typedef struct _t_ASPlatformPath *ASPlatformPath;

Used By

CFURLRefRec_Ptr

Header: ASExpT.h:2227

Syntax

typedef CFURLRefRec *CFURLRefRec_Ptr;

CFURLRefRec_Ptr

Header: ASExpT.h:2241

Syntax

typedef CFURLRefRecPlacebo *CFURLRefRec_Ptr;

Returned From

Cstring_Ptr

Header: ASExpT.h:2177

Description

A UNIX or Windows platform-specific path value.

Syntax

typedef char *Cstring_Ptr;

Returned From

FSRefWithCFStringRefRec_Ptr

Header: ASExpT.h:2214

Syntax

typedef FSRefWithCFStringRefRec *FSRefWithCFStringRefRec_Ptr;

FSRefWithCFStringRefRec_Ptr

Header: ASExpT.h:2237

Syntax

typedef FSRefWithCFStringRefRecPlacebo *FSRefWithCFStringRefRec_Ptr;

Returned From

FSRef_Ptr

Header: ASExpT.h:2198

Description

A pointer to a Mac OS platform-specific FSRef.

Related Methods

Syntax

typedef struct FSRef *FSRef_Ptr;

FSRef_Ptr

Header: ASExpT.h:2232

Syntax

typedef struct FSRefPlacebo *FSRef_Ptr;

Returned From

FSSpec_Ptr

Header: ASExpT.h:2191

Description

A pointer to a Mac OS platform-specific FSSpec.

Related Methods

Syntax

typedef struct FSSpec *FSSpec_Ptr;

FSSpec_Ptr

Header: ASExpT.h:2231

Syntax

typedef struct FSSpecPlacebo *FSSpec_Ptr;

Returned From

POSIXPath_Ptr

Header: ASExpT.h:2182

Description

A C string containing a POSIX path (UTF-8 encoding).

Syntax

typedef char *POSIXPath_Ptr;

Returned From

ASPlatformPath Structures

_t_CFURLRefRec

Header: ASExpT.h:2221

Description

A structure containing the equivalent of a Mac OS platform-specific CFURLRef.

Related Methods

Syntax

struct _t_CFURLRefRec {
const struct __CFURL *url;
} CFURLRefRec;

_t_CFURLRefRecPlacebo

Header: ASExpT.h:2238

Syntax

struct _t_CFURLRefRecPlacebo {
const struct __CFURLPlacebo *url;
} CFURLRefRecPlacebo;

_t_FSRefWithCFStringRefRec

Header: ASExpT.h:2206

Description

A structure containing the equivalent of two Mac OS platform-specific types: a pointer to an FSRef and a CFStringRef.

Related Methods

Syntax

struct _t_FSRefWithCFStringRefRec {
struct FSRef *ref;
const struct __CFString *str;
Definition of a CFStringRef.
} FSRefWithCFStringRefRec;

_t_FSRefWithCFStringRefRecPlacebo

Header: ASExpT.h:2233

Syntax

struct _t_FSRefWithCFStringRefRecPlacebo {
struct FSRefPlacebo *ref;
const struct __CFStringPlacebo *str;
} FSRefWithCFStringRefRecPlacebo;

ASPlatformPath Functions

ASPathFromPlatformPath

Header: ASProcs.h:680

Description

This method was deprecated in Acrobat 5.0. Use ASFileSysCreatePathName() instead.

It converts a platform-specific path name to an ASPathName. It can create an ASPathName from a file path where the file does not already exist. It works for Windows UNC path names as well. It is the caller's responsibility to release the returned ASPathName.

Related Methods

Syntax

ASPathName ASPathFromPlatformPath(void *platformPath);

Parameters

platformPath
A pointer to a platform-specific path name. On Windows and UNIX, it is a NULL-terminated string containing the full path name with the appropriate path separators for each platform.

Returns

The ASPathName corresponding to platformPath.

ASPlatformPathGetCFURLRefRecPtr

Header: ASProcs.h:2395

Description

Gets a platform path object in the form of a CFURLRef for the Mac OS, if the ASPlatformPath object was acquired with this type in the platformPathType parameter of ASFileSysAcquirePlatformPath().

Note: Do not release the returned value, or any member data of an ASPlatformPath directly; use ASFileSysReleasePlatformPath() when finished with the object.

Related Methods

ASFileSysAcquirePlatformPath ASFileSysReleasePlatformPath

Syntax

CFURLRefRec_Ptr ASPlatformPathGetCFURLRefRecPtr(ASPlatformPath path);

Parameters

path
The platform path.

Returns

A pointer to a structure containing a CFURLRef.

ASPlatformPathGetCstringPtr

Header: ASProcs.h:2320

Description

Gets a platform path object in the form of a C string for Windows or UNIX, if the ASPlatformPath object was acquired with this type in the platformPathType parameter of ASFileSysAcquirePlatformPath().

Note: Applications should use this as a read-only pointer; modifying the returned buffer can corrupt the ASPlatformPath. Do not free the pointer.

Note: Do not release the returned value, or any member data of an ASPlatformPath directly; use ASFileSysReleasePlatformPath() when finished with the object.

Related Methods

ASFileSysAcquirePlatformPath ASFileSysReleasePlatformPath

Syntax

Cstring_Ptr ASPlatformPathGetCstringPtr(ASPlatformPath path);

Parameters

path
The platform path.

Returns

A pointer to a C string of a platform-specific path.

ASPlatformPathGetFSRefPtr

Header: ASProcs.h:2360

Description

Gets a platform path object in the form of an FSRef for the Mac OS, if the ASPlatformPath object was acquired with this type in the platformPathType parameter of ASFileSysAcquirePlatformPath().

Note: Do not release the returned value, or any member data of an ASPlatformPath directly; use ASFileSysReleasePlatformPath() when finished with the object.

Related Methods

ASFileSysAcquirePlatformPath ASFileSysReleasePlatformPath ASPlatformPathGetFSRefWithCFStringRefRecPtr

Syntax

FSRef_Ptr ASPlatformPathGetFSRefPtr(ASPlatformPath path);

Parameters

path
The platform path.

Returns

A pointer to an FSRef.

ASPlatformPathGetFSRefWithCFStringRefRecPtr

Header: ASProcs.h:2379

Description

Gets a platform path object in the form of an FSRef and CFStringRef for Mac OS, if the ASPlatformPath object was acquired with this type in the platformPathType parameter of ASFileSysAcquirePlatformPath().

Note: Do not release the returned value, or any member data of an ASPlatformPath directly; use ASFileSysReleasePlatformPath() when finished with the object.

Related Methods

ASFileSysAcquirePlatformPath ASFileSysReleasePlatformPath ASPlatformPathGetFSRefPtr

Syntax

FSRefWithCFStringRefRec_Ptr ASPlatformPathGetFSRefWithCFStringRefRecPtr(ASPlatformPath path);

Parameters

path
The platform path.

Returns

A pointer to a structure containing an FSRef and a CFStringRef.

ASPlatformPathGetFSSpecPtr

Header: ASProcs.h:2342

Description

This method was deprecated in Acrobat 9.0. Use ASPlatformPathGetFSRefPtr(), ASPlatformPathGetFSRefWithCFStringRefRecPtr(), ASPlatformPathGetCFURLRefRecPtr(), or ASPlatformPathGetPOSIXPathPtr() instead. Gets a platform path object in the form of an FSSpec for the Mac OS, if the ASPlatformPath object was acquired with this type in the platformPathType parameter of ASFileSysAcquirePlatformPath().

Note: Do not release the returned value, or any member data of an ASPlatformPath directly; use ASFileSysReleasePlatformPath() when finished with the object.

Related Methods

ASFileSysAcquirePlatformPath ASFileSysReleasePlatformPath ASPlatformPathGetFSRefPtr

Syntax

FSSpec_Ptr ASPlatformPathGetFSSpecPtr(ASPlatformPath path);

Parameters

path
The platform path.

Returns

A pointer to an FSSpec.

ASPlatformPathGetPOSIXPathPtr

Header: ASProcs.h:2412

Description

Gets a platform path object in the form of a POSIX path C string, if the ASPlatformPath object was acquired with this type in the platformPathType parameter of ASFileSysAcquirePlatformPath().

Note: Do not release the returned value, or any member data of an ASPlatformPath directly; use ASFileSysReleasePlatformPath() when finished with the object.

Related Methods

ASFileSysAcquirePlatformPath ASFileSysReleasePlatformPath

Syntax

POSIXPath_Ptr ASPlatformPathGetPOSIXPathPtr(ASPlatformPath path);

Parameters

path
The platform path.

Returns

A pointer to a POSIX path (UTF-8 encoding) as a C string.