XML Security Library Reference Manual
<<< Previous Page | Home | Up | Next Page >>>

# io.h

## Name

io.h -- The IO transforms.

## Synopsis

    void        xmlSecIOInit                    (void);
    void        xmlSecIOShutdown                (void);
    extern      xmlSecTransformId xmlSecInputUri;
    int         xmlSecInputUriTransformOpen     (xmlSecTransformPtr transform,
                                                 const char *uri);
    void        xmlSecCleanupInputCallbacks     (void);
    void        xmlSecRegisterDefaultInputCallbacks
                                                (void);
    int         xmlSecRegisterInputCallbacks    (xmlInputMatchCallback matchFunc,
                                                 xmlInputOpenCallback openFunc,
                                                 xmlInputReadCallback readFunc,
                                                 xmlInputCloseCallback closeFunc);

## Description

## Details

### xmlSecIOInit ()

    void        xmlSecIOInit                    (void);

The IO initialization (called from xmlSecInit() function). Applications should not call this function directly.

### xmlSecIOShutdown ()

    void        xmlSecIOShutdown                (void);

The IO clenaup (called from xmlSecShutdown() function). Applications should not call this function directly.

### xmlSecInputUri

    extern xmlSecTransformId xmlSecInputUri;

The input URI transform id.

### xmlSecInputUriTransformOpen ()

    int         xmlSecInputUriTransformOpen     (xmlSecTransformPtr transform,
                                                 const char *uri);

Opens the given `uri` for reading.

`transform` : | the pointer to IO transform.
`uri` : | the URL to open.
Returns : | 0 on success or a negative value otherwise.

### xmlSecCleanupInputCallbacks ()

    void        xmlSecCleanupInputCallbacks     (void);

Clears the entire input callback table. this includes the compiled-in I/O.

### xmlSecRegisterDefaultInputCallbacks ()

    void        xmlSecRegisterDefaultInputCallbacks
                                                (void);

Registers the default compiled-in I/O handlers.

### xmlSecRegisterInputCallbacks ()

    int         xmlSecRegisterInputCallbacks    (xmlInputMatchCallback matchFunc,
                                                 xmlInputOpenCallback openFunc,
                                                 xmlInputReadCallback readFunc,
                                                 xmlInputCloseCallback closeFunc);

Register a new set of I/O callback for handling parser input.

`matchFunc` : | the xmlInputMatchCallback.
`openFunc` : | the xmlInputOpenCallback.
`readFunc` : | the xmlInputReadCallback.
`closeFunc` : | the xmlInputCloseCallback.
Returns : | the registered handler number or a negative value if an error occurs.

<<< Previous Page | Home | Up | Next Page >>>
digests.h | keysInternal.h