DL Logo

ASCryptStm Definitions

ASCRYPTSTM_EOF

Header: ASExpT.h:306

Syntax

#define ASCRYPTSTM_EOF ( - 1 )

ASCryptStmModeEOF

Header: ASExpT.h:317

Syntax

#define ASCryptStmModeEOF 0x0004

ASCryptStmModeRead

Header: ASExpT.h:315

Syntax

#define ASCryptStmModeRead 0x0001

ASCryptStmModeWrite

Header: ASExpT.h:316

Syntax

#define ASCryptStmModeWrite 0x0002

ASCryptStm Typedefs

ASCryptStm

Header: ASExpT.h:325

Description

An ASStm object cover used for a cryptographic filter's stream callbacks.

Syntax

typedef struct _t_ASCryptStmRec *ASCryptStm;

Used By

ASCryptStm Callback Signatures

ASCryptStmFCloseProc

Header: ASExpT.h:401

Description

A callback for ASCryptStm. This closes a security stream.

Syntax

ASInt32 ASCryptStmFCloseProc(ASCryptStm stm);

Parameters

stm
The security stream to be closed.

Returns

0 when successful, a non-zero error code otherwise.

Used In

ASCryptStmFFlushProc

Header: ASExpT.h:388

Description

A callback for ASCryptStm. This flushes a dirty buffer if necessary.

Syntax

ASInt32 ASCryptStmFFlushProc(ASCryptStm stm);

Parameters

stm
The security stream to be flushed.

Returns

0 when successful, a non-zero error code otherwise.

Used In

ASCryptStmFPutEOFProc

Header: ASExpT.h:429

Description

A callback for ASCryptStm. This puts an end-of-file (EOF) marker to a security stream.

Syntax

ASInt32 ASCryptStmFPutEOFProc(ASCryptStm stm);

Parameters

stm
The security stream to receive the EOF.

Returns

0 when successful, a non-zero error code otherwise.

Used In

ASCryptStmFResetProc

Header: ASExpT.h:415

Description

A callback for ASCryptStm. This resets a security stream, discarding any buffered data. It is called only during encryption (when writing to the stream, not when reading).

Syntax

ASInt32 ASCryptStmFResetProc(ASCryptStm stm);

Parameters

stm
The security stream to be reset.

Returns

0 when successful, a non-zero error code otherwise.

Used In

ASCryptStmFilBufProc

Header: ASExpT.h:341

Description

A callback for ASCryptStm. This is called by getc when the buffer is empty. It is called only during decryption (when reading from the stream, not when writing).

Syntax

ASInt32 ASCryptStmFilBufProc(ASCryptStm pistm);

Parameters

pistm
The security stream to fill.

Returns

0 when successful, a non-zero error code otherwise.

Used In

ASCryptStmFlsBufProc

Header: ASExpT.h:357

Description

A callback for ASCryptStm. This is called by putc when the buffer is full. It is called only during encryption (when writing to the stream, not when reading).

Syntax

ASInt32 ASCryptStmFlsBufProc(ASInt32 ch, ASCryptStm stm);

Parameters

ch
The character being written to the full stream.
stm
The security stream that is full.

Returns

0 when successful, a non-zero error code otherwise.

Used In

ASCryptStmUnGetcProc

Header: ASExpT.h:374

Description

A callback for ASCryptStm. It goes back one character in the input stream, undoing a character get operation. It is called only during decryption (when reading from the stream, not when writing).

Syntax

ASInt32 ASCryptStmUnGetcProc(ASInt32 ch, ASCryptStm stm);

Parameters

ch
The character being written to the stream.
stm
The security stream to which the character is written.

Returns

0 when successful, a non-zero error code otherwise.

Used In

ASCryptStm Structures

ASCryptStmProcs

Header: ASExpT.h:432

Description

Callback procs for ASCryptStm

Syntax

struct ASCryptStmProcs {
Called by getc when the buffer is empty.
Called by putc when the buffer is full.
Backs up an input stream.
Flushes a dirty buffer if necessary.
Closes a stream.
Discards any buffered data.
Puts an EOF marker.
} ASCryptStmProcs;

Used In

_t_ASCryptStmRec

Header: ASExpT.h:454

Description

An ASStm object cover used for a cryptographic filter's stream callbacks.

Related Methods

Syntax

struct _t_ASCryptStmRec {
ASInt32 count;
The number of characters remaining in the buffer.
char *currentPointer;
The next character to get or put.
char *basePointer;
The base of the buffer, if any.
ASUns32 modeFlag;
Flag to indicate mode:
Flag
Value
0x0001 (decryption)
0x0002 (encryption)
0x0004
0x0008
Handlers for security stream access.
ASStm baseStm;
The base ASStm object.
ASInt32 nBytesWanted;
The number of bytes requested for decryption.
void *clientData;
A pointer to arbitrary user-defined data.
} ASCryptStmRec;

Used In