Main Page Cookbook/Overview ImageMeister the jcprops file Licensing Binary Installation & Configuration [ Win · Mac · Nix · OSX ] Changes Public API Source Code Main Page Java [ Common · Win · Mac · Nix ] Native Code [ Common · Win · Mac · Nix ] Manifest Native Code Overviews [ Common · Win · Mac · Nix · Strings ] Macros [ General · Native Macros ] Walkthroughs [ Java only · Java and native ] Building [ Win · Mac · Nix · OSX ] Distribution Issues

# CFSpec

  Represents an FSSpec.

[ Mac | Source | Keywords | Summary | Ancestors | All Members | Descendants ]

## Quick Index

  DESCRIPTION
  MACROS

## Class Summary

class CFSpec
{
public:

  CFSpec( JNIEnv *pEnv, long vr, long pi, JBYTEARRAY pNm );
  CFSpec( JRIEnv *pEnv, long vr, long pi, JBYTEARRAY pNm );
  CFSpec( long vr, long pi, StringPtr ps );
  CFSpec( const CFSpec *cfs );
  ~CFSpec();
  long getVRef() const;
  long getParID() const;
  StringPtr getName();
  FSSpec *getSpecP();
  ErrCode verifySpec();
  BOOL isNameNull() const;
  void setFrom( const CFSpec *cfs );
  void setFrom( long vr, long pi, StringPtr ps );
  void putInto( FSSpec *toSpec ) const;
  void dumpInfo( long theErr, const LPCTSTR message ) const;

protected:

}; // CFSpec

Back to the top of CFSpec

### DESCRIPTION

Represents an FSSpec. This is constructed from a vRef, a parID, and either a JBYTEARRAY containing a Pascal string or a Pascal string. A set of macros is provided to make declaration, construction, and deletion easier

Back to the top of CFSpec

### MACROS

    DECLARECFSPEC(a)
    	Allocates space for a CFSpec*, and sets it to null

    MAKECFSPEC(a,b,c,d)
    	Constructs a CFSpec from two jints and a JBYTEARRAY
    	'a' is the CFSpec*
    	'b' is the vRefNum
    	'c' is the parID
    	'd' is the JBYTEARRAY

    DELETECFSPEC(a)
    	If 'a' isn't null, calls 'delete' on it.

Back to the top of CFSpec

### CFSpec( JNIEnv *pEnv, long vr, long pi, JBYTEARRAY pNm );

Construct using a JNI byte array. Available only in JNI builds. if pNm is NULL, the FSSpec's name will be set to an empty string.

    	CFSpec( JNIEnv *pEnv, long vr, long pi, JBYTEARRAY pNm );

Back to the top of CFSpec

### CFSpec( JRIEnv *pEnv, long vr, long pi, JBYTEARRAY pNm );

Construct using a JRI byte array. Available only in JRI builds. if pNm is NULL, the FSSpec's name will be set to an empty string.

    	CFSpec( JRIEnv *pEnv, long vr, long pi, JBYTEARRAY pNm );

Back to the top of CFSpec

### CFSpec( long vr, long pi, StringPtr ps );

Construct using a Pascal string if ps is NULL, the FSSpec's name will be set to an empty string.

    	CFSpec( long vr, long pi, StringPtr ps );

Back to the top of CFSpec

### CFSpec( const CFSpec *cfs );

Copy constructor

    	CFSpec( const CFSpec *cfs );

Back to the top of CFSpec

### ~CFSpec();

Destructor

    	virtual	~CFSpec();

Back to the top of CFSpec

### long getVRef() const;

Return vRefNum

    	virtual	long		getVRef() const;

Back to the top of CFSpec

### long getParID() const;

Returns parID

    	virtual	long		getParID() const;

Back to the top of CFSpec

### StringPtr getName();

Returns a pointer to the name

    	virtual	StringPtr	getName();

Back to the top of CFSpec

### FSSpec *getSpecP();

Returns a pointer to the FSSpec

    	virtual	FSSpec		*getSpecP();

Back to the top of CFSpec

### ErrCode verifySpec();

Calls FSMakeFSSpec(), returns return value.

    	virtual	ErrCode		verifySpec();

Back to the top of CFSpec

### BOOL isNameNull() const;

Indicates whether name[0] == 0

    	virtual	BOOL		isNameNull() const;

Back to the top of CFSpec

### void setFrom( const CFSpec *cfs );

Reinitialize from another CFSpec.

    	virtual	void		setFrom( const CFSpec *cfs );

Back to the top of CFSpec

### void setFrom( long vr, long pi, StringPtr ps );

Reinitialize from a Pascal string.

    	virtual	void		setFrom( long vr, long pi, StringPtr ps );

Back to the top of CFSpec

### void putInto( FSSpec *toSpec ) const;

Copy to an FSSpec

    	virtual	void		putInto( FSSpec *toSpec ) const;

Back to the top of CFSpec

### void dumpInfo( long theErr, const LPCTSTR message ) const;

Write info on the spec to the debugger

    	virtual	void		dumpInfo( long theErr, const LPCTSTR message ) const;

Back to the top of CFSpec

## All Members

public:
  long getVRef() const;
  long getParID() const;
  StringPtr getName();
  FSSpec *getSpecP();
  ErrCode verifySpec();
  BOOL isNameNull() const;
  void setFrom( const CFSpec *cfs );
  void setFrom( long vr, long pi, StringPtr ps );
  void putInto( FSSpec *toSpec ) const;
  void dumpInfo( long theErr, const LPCTSTR message ) const;
protected:

Back to the top of CFSpec

## Ancestors

Class does not inherit from any other class.

Back to the top of CFSpec

## Descendants

Class is not inherited by any others.

Back to the top of CFSpec

Generated from source by the Cocoon utilities on Fri Aug 23 12:34:26 2002 .

Main Page · JConfig · ImageMeister · System Properties Repository · WordMeister · Free Samples · Java Freeware · Contact Us · FAQ · Links

Copyright (c) 1997-2002 Samizdat Productions. All Rights Reserved.
WarpMovie, TileMovie, JConfig, ImageMeister and MovieShredder are Trademarks of Samizdat Productions.