The Free and Open Productivity Suite
Follow us on Twitter: @ApacheOO

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


Global Functions in Global Namespace C++
in Sourcefile pipe.h


osl_acceptPipe
extern "C"
oslPipe osl_acceptPipe(
oslPipe Pipe );

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO NO YES


osl_acquirePipe
extern "C"
void osl_acquirePipe(
oslPipe Pipe );

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO NO YES

Summary
increases the refcount of the pipe.

osl_closePipe
extern "C"
void osl_closePipe(
oslPipe );

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO NO YES

Summary
closes the pipe, any read,write or accept actions stop immeadiatly.

osl_createPipe
extern "C"
oslPipe osl_createPipe(
rtl_uString * strPipeName,
oslPipeOptions Options,
oslSecurity Security );

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO NO YES


osl_getLastPipeError
extern "C"
oslPipeError osl_getLastPipeError(
oslPipe Pipe );

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO NO YES


osl_readPipe
extern "C"
sal_Int32 osl_readPipe(
oslPipe Pipe,
void * pBuffer,
sal_Int32 BufferSize );

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO NO YES

Summary
Reads blocking from the pipe.
Return
Number of read bytes. If less than BufferSize, the pipe was closed.

osl_receivePipe
extern "C"
sal_Int32 osl_receivePipe(
oslPipe Pipe,
void * pBuffer,
sal_Int32 BufferSize );

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO NO YES


osl_releasePipe
extern "C"
void osl_releasePipe(
oslPipe );

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO NO YES

Summary
decreases the refcount of the pipe. If the refcount drops to zero, the handle is destroyed.

osl_sendPipe
extern "C"
sal_Int32 osl_sendPipe(
oslPipe Pipe,
const void * pBuffer,
sal_Int32 BufferSize );

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO NO YES


osl_writePipe
extern "C"
sal_Int32 osl_writePipe(
oslPipe Pipe,
const void * pBuffer,
sal_Int32 BufferSize );

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO NO YES

Summary
Writes blocking onto the pipe.
Return
Number of written bytes. If less than BufferSize, the pipe was closed.

Top of Page

Apache Software Foundation

Copyright & License | Privacy | Website Feedback | Contact Us | Donate | Thanks

Apache, the Apache feather logo, and OpenOffice are trademarks of The Apache Software Foundation. OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.