LayerAS_Layer
ObjectASPlatformPath

An opaque object used to retrieve a platform-specific path object. This object was added in Acrobat 6.0 to improve device-independent path referencing.


Typedef Summary
 Typedef
 ASPlatformPath
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().
 CFURLRefRec (Macintosh)
 CFURLRefRecPlacebo (Windows, UNIX)
 CFURLRefRec_Ptr (Macintosh)
 CFURLRefRec_Ptr (Windows, UNIX)
 Cstring_Ptr
A UNIX or Windows platform-specific path value.
 FSRef_Ptr (Macintosh)
A pointer to a Mac OS platform-specific FSRef.
 FSRef_Ptr (Windows, UNIX)
 FSRefWithCFStringRefRec (Macintosh)
 FSRefWithCFStringRefRecPlacebo (Windows, UNIX)
 FSRefWithCFStringRefRec_Ptr (Macintosh)
 FSRefWithCFStringRefRec_Ptr (Windows, UNIX)
 FSSpec_Ptr (Macintosh)
A pointer to a Mac OS platform-specific FSSpec.
 FSSpec_Ptr (Windows, UNIX)
 POSIXPath_Ptr
A C string containing a POSIX path (UTF-8 encoding).
Structure Summary
 Structure
 _t_CFURLRefRec (Macintosh)
A structure containing the equivalent of a Mac OS platform-specific CFURLRef.
 _t_CFURLRefRecPlacebo (Windows, UNIX)
 _t_FSRefWithCFStringRefRec (Macintosh)
A structure containing the equivalent of two Mac OS platform-specific types: a pointer to an FSRef and a CFStringRef.
 _t_FSRefWithCFStringRefRecPlacebo (Windows, UNIX)
Method Summary
 Method
 
CFURLRefRec_Ptr ASPlatformPathGetCFURLRefRecPtr(ASPlatformPath path)
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().
 
Cstring_Ptr ASPlatformPathGetCstringPtr(ASPlatformPath path)
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().
 
FSRef_Ptr ASPlatformPathGetFSRefPtr(ASPlatformPath path)
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().
 
FSRefWithCFStringRefRec_Ptr ASPlatformPathGetFSRefWithCFStringRefRecPtr(ASPlatformPath path)
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().
 
FSSpec_Ptr ASPlatformPathGetFSSpecPtr(ASPlatformPath path)
This method was deprecated in Acrobat 9.0. Use ASPlatformPathGetFSRefPtr(), ASPlatformPathGetFSRefWithCFStringRefRecPtr(), ASPlatformPathGetCFURLRefRecPtr(), or ASPlatformPathGetPOSIXPathPtr() instead.
 
POSIXPath_Ptr ASPlatformPathGetPOSIXPathPtr(ASPlatformPath path)
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().

Typedefs Detail
ASPlatformPath 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef struct _t_ASPlatformPath* ASPlatformPath;

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().


File: ASExpT.h
Line: 2176
CFURLRefRec 
Product availability: PDFL
Platform availability: Macintosh

Syntax

typedef _t_CFURLRefRec CFURLRefRec;

File: ASExpT.h
Line: 2228
CFURLRefRec_Ptr 
Product availability: PDFL
Platform availability: Macintosh

Syntax

typedef CFURLRefRec CFURLRefRec_Ptr;

File: ASExpT.h
Line: 2231
CFURLRefRec_Ptr 
Product availability: PDFL
Platform availability: Windows, UNIX

Syntax

typedef CFURLRefRecPlacebo CFURLRefRec_Ptr;

File: ASExpT.h
Line: 2245
CFURLRefRecPlacebo 
Product availability: PDFL
Platform availability: Windows, UNIX

Syntax

typedef _t_CFURLRefRecPlacebo CFURLRefRecPlacebo;

File: ASExpT.h
Line: 2244
Cstring_Ptr 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef char* Cstring_Ptr;

A UNIX or Windows platform-specific path value.

See Also

ASPlatformPathGetCstringPtr

File: ASExpT.h
Line: 2181
FSRef_Ptr 
Product availability: PDFL
Platform availability: Macintosh

Syntax

typedef struct FSRef* FSRef_Ptr;

A pointer to a Mac OS platform-specific FSRef.

See Also

ASPlatformPathGetFSRefPtr

File: ASExpT.h
Line: 2202
FSRef_Ptr 
Product availability: PDFL
Platform availability: Windows, UNIX

Syntax

typedef struct FSRefPlacebo* FSRef_Ptr;

File: ASExpT.h
Line: 2236
FSRefWithCFStringRefRec 
Product availability: PDFL
Platform availability: Macintosh

Syntax

typedef _t_FSRefWithCFStringRefRec FSRefWithCFStringRefRec;

File: ASExpT.h
Line: 2215
FSRefWithCFStringRefRec_Ptr 
Product availability: PDFL
Platform availability: Macintosh

Syntax

typedef FSRefWithCFStringRefRec FSRefWithCFStringRefRec_Ptr;

File: ASExpT.h
Line: 2218
FSRefWithCFStringRefRec_Ptr 
Product availability: PDFL
Platform availability: Windows, UNIX

Syntax

typedef FSRefWithCFStringRefRecPlacebo FSRefWithCFStringRefRec_Ptr;

File: ASExpT.h
Line: 2241
FSRefWithCFStringRefRecPlacebo 
Product availability: PDFL
Platform availability: Windows, UNIX

Syntax

typedef _t_FSRefWithCFStringRefRecPlacebo FSRefWithCFStringRefRecPlacebo;

File: ASExpT.h
Line: 2240
FSSpec_Ptr 
Product availability: PDFL
Platform availability: Macintosh

Syntax

typedef struct FSSpec* FSSpec_Ptr;

A pointer to a Mac OS platform-specific FSSpec.

See Also

ASPlatformPathGetFSSpecPtr

File: ASExpT.h
Line: 2195
FSSpec_Ptr 
Product availability: PDFL
Platform availability: Windows, UNIX

Syntax

typedef struct FSSpecPlacebo* FSSpec_Ptr;

File: ASExpT.h
Line: 2235
POSIXPath_Ptr 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef char* POSIXPath_Ptr;

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

See Also

ASPlatformPathGetPOSIXPathPtr

File: ASExpT.h
Line: 2186


Structure Detail
_t_CFURLRefRec
Product availability: PDFL
Platform availability: Macintosh

Syntax

struct _t_CFURLRefRec {
 struct __CFURL* url; 
}

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

See Also

ASPlatformPathGetCFURLRefRecPtr

File: ASExpT.h
Line: 2225

_t_CFURLRefRecPlacebo 
Product availability: PDFL
Platform availability: Windows, UNIX

Syntax

struct _t_CFURLRefRecPlacebo {
 struct __CFURLPlacebo* url; 
}

File: ASExpT.h
Line: 2242

_t_FSRefWithCFStringRefRec 
Product availability: PDFL
Platform availability: Macintosh

Syntax

struct _t_FSRefWithCFStringRefRec {
 struct FSRef* ref; 
 
 struct __CFString* str; 
}

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

See Also

ASPlatformPathGetFSRefWithCFStringRefRecPtr

File: ASExpT.h
Line: 2210

_t_FSRefWithCFStringRefRecPlacebo 
Product availability: PDFL
Platform availability: Windows, UNIX

Syntax

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

File: ASExpT.h
Line: 2237


Method Detail
ASPlatformPathGetCFURLRefRecPtr()
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

CFURLRefRec_Ptr ASPlatformPathGetCFURLRefRecPtr(ASPlatformPath path)

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().

Parameters

path — 

The platform path.

Returns

A pointer to a structure containing a CFURLRef.

See Also

ASFileSysAcquirePlatformPath
ASFileSysReleasePlatformPath

Since

PI_ACROSUPPORT_VERSION >= 0x00060000

Note

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

File: ASProcs.h
Line: 2371
ASPlatformPathGetCstringPtr() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

Cstring_Ptr ASPlatformPathGetCstringPtr(ASPlatformPath path)

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().

Parameters

path — 

The platform path.

Returns

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

See Also

ASFileSysAcquirePlatformPath
ASFileSysReleasePlatformPath

Since

PI_ACROSUPPORT_VERSION >= 0x00060000

Note

Applications should use this as a read-only pointer; modifying the returned buffer can corrupt the ASPlatformPath. Do not free the pointer.
Do not release the returned value, or any member data of an ASPlatformPath directly; use ASFileSysReleasePlatformPath() when finished with the object.

File: ASProcs.h
Line: 2296
ASPlatformPathGetFSRefPtr() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

FSRef_Ptr ASPlatformPathGetFSRefPtr(ASPlatformPath path)

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().

Parameters

path — 

The platform path.

Returns

A pointer to an FSRef.

See Also

ASFileSysAcquirePlatformPath
ASPlatformPathGetFSRefWithCFStringRefRecPtr
ASFileSysReleasePlatformPath

Since

PI_ACROSUPPORT_VERSION >= 0x00060000

Note

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

File: ASProcs.h
Line: 2336
ASPlatformPathGetFSRefWithCFStringRefRecPtr() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

FSRefWithCFStringRefRec_Ptr ASPlatformPathGetFSRefWithCFStringRefRecPtr(ASPlatformPath path)

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().

Parameters

path — 

The platform path.

Returns

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

See Also

ASFileSysAcquirePlatformPath
ASPlatformPathGetFSRefPtr
ASFileSysReleasePlatformPath

Since

PI_ACROSUPPORT_VERSION >= 0x00060000

Note

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

File: ASProcs.h
Line: 2355
ASPlatformPathGetFSSpecPtr() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

FSSpec_Ptr ASPlatformPathGetFSSpecPtr(ASPlatformPath path)

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().

Parameters

path — 

The platform path.

Returns

A pointer to an FSSpec.

See Also

ASFileSysAcquirePlatformPath
ASPlatformPathGetFSRefPtr
ASFileSysReleasePlatformPath

Since

PI_ACROSUPPORT_VERSION >= 0x00060000

Note

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

File: ASProcs.h
Line: 2318
ASPlatformPathGetPOSIXPathPtr() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

POSIXPath_Ptr ASPlatformPathGetPOSIXPathPtr(ASPlatformPath path)

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().

Parameters

path — 

The platform path.

Returns

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

See Also

ASFileSysAcquirePlatformPath
ASFileSysReleasePlatformPath

Since

PI_ACROSUPPORT_VERSION >= 0x00060000

Note

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

File: ASProcs.h
Line: 2388



Copyright 2020 Adobe Systems Incorporated and its licensors. All rights reserved. Adobe and the Adobe logo are either registered trademarks or trademarks of Adobe Systems Incorporated in the United States and/or other countries. This product contains either BSAFE and/or TIPEM software by RSA Security, Inc. Portions utilize Microsoft Windows Media Technologies. Copyright © 2006 Microsoft Corporation. All Rights Reserved. Notices, terms and conditions pertaining to other third party software are located at http://www.adobe.com/go/thirdparty/ and incorporated herein by reference.
Wed Feb 7 2024, 2:16 pm IST