X-Git-Url: http://git.ipfire.org/?p=thirdparty%2Fcups.git;a=blobdiff_plain;f=doc%2Fhelp%2Fapi-filedir.html;h=e8e765d70eae052c2474ee58584701905337cf0b;hp=fa862e96fb6aee75d3949cbe03c4b91e56ec1d68;hb=bc44d92092094935265183305a38196ce2822756;hpb=09a101d671d39312a756c325d8463a1a02f582a6 diff --git a/doc/help/api-filedir.html b/doc/help/api-filedir.html index fa862e96f..e8e765d70 100644 --- a/doc/help/api-filedir.html +++ b/doc/help/api-filedir.html @@ -16,27 +16,18 @@

Introduction

@@ -124,15 +115,15 @@ library:

cupsDirClose()

Description

-

Close a directory.

+

Close a directory.

Syntax

-
-void
+

+void

 cupsDirClose(
     cups_dir_t * dp);
-
+

Arguments

-
+
@@ -142,15 +133,15 @@ cupsDirClose(

cupsDirOpen()

Description

-

Open a directory.

+

Open a directory.

Syntax

-
-cups_dir_t *
+

+cups_dir_t *

 cupsDirOpen(
     const char * directory);
-
+

Arguments

-
NameDescription
dpDirectory
+
@@ -160,15 +151,15 @@ cupsDirOpen(

cupsDirRead()

Description

-

Read the next directory entry.

+

Read the next directory entry.

Syntax

-
-cups_dentry_t *
+

+cups_dentry_t *

 cupsDirRead(
     cups_dir_t * dp);
-
+

Arguments

-
NameDescription
directoryDirectory name
+
@@ -178,15 +169,15 @@ cupsDirRead(

cupsDirRewind()

Description

-

Rewind to the start of the directory.

+

Rewind to the start of the directory.

Syntax

-
-void
+

+void

 cupsDirRewind(
     cups_dir_t * dp);
-
+

Arguments

-
NameDescription
dpDirectory
+
@@ -196,15 +187,15 @@ cupsDirRewind(

cupsFileClose()

Description

-

Close a CUPS file.

+

Close a CUPS file.

Syntax

-
-int
+

+int

 cupsFileClose(
     cups_file_t * fp);
-
+

Arguments

-
NameDescription
dpDirectory
+
@@ -214,15 +205,15 @@ cupsFileClose(

cupsFileCompression()

Description

-

Return whether a file is compressed.

+

Return whether a file is compressed.

Syntax

-
-int
+

+int

 cupsFileCompression(
     cups_file_t * fp);
-
+

Arguments

-
NameDescription
fpCUPS file
+
@@ -232,15 +223,15 @@ cupsFileCompression(

cupsFileEOF()

Description

-

Return the end-of-file status.

+

Return the end-of-file status.

Syntax

-
-int
+

+int

 cupsFileEOF(
     cups_file_t * fp);
-
+

Arguments

-
NameDescription
fpCUPS file
+
@@ -251,24 +242,23 @@ cupsFileEOF(

cupsFileFind()

Description

Find a file using the specified path. - -This function allows the paths in the path string to be separated by +

This function allows the paths in the path string to be separated by colons (UNIX standard) or semicolons (Windows standard) and stores the result in the buffer supplied. If the file cannot be found in any of the supplied paths, NULL is returned. A NULL path only matches the -current directory.

+current directory.

Syntax

-
-const char *
+

+const char *

 cupsFileFind(
     const char * filename,
     const char * path,
     int executable,
     char * buffer,
     int bufsize);
-
+

Arguments

-
NameDescription
fpCUPS file
+
@@ -282,15 +272,15 @@ cupsFileFind(

cupsFileFlush()

Description

-

Flush pending output.

+

Flush pending output.

Syntax

-
-int
+

+int

 cupsFileFlush(
     cups_file_t * fp);
-
+

Arguments

-
NameDescription
filenameFile to find
+
@@ -300,15 +290,15 @@ cupsFileFlush(

cupsFileGetChar()

Description

-

Get a single character from a file.

+

Get a single character from a file.

Syntax

-
-int
+

+int

 cupsFileGetChar(
     cups_file_t * fp);
-
+

Arguments

-
NameDescription
fpCUPS file
+
@@ -318,19 +308,19 @@ cupsFileGetChar(

cupsFileGetConf()

Description

-

Get a line from a configuration file...

+

Get a line from a configuration file...

Syntax

-
-char *
+

+char *

 cupsFileGetConf(
     cups_file_t * fp,
     char * buf,
     size_t buflen,
     char ** value,
     int * linenum);
-
+

Arguments

-
NameDescription
fpCUPS file
+
@@ -346,21 +336,20 @@ cupsFileGetConf(

Description

Get a CR and/or LF-terminated line that may contain binary data. - -This function differs from cupsFileGets() in that the trailing CR and LF +

This function differs from cupsFileGets() in that the trailing CR and LF are preserved, as is any binary data on the line. The buffer is nul- terminated, however you should use the returned length to determine -the number of bytes on the line.

+the number of bytes on the line.

Syntax

-
-size_t
+

+size_t

 cupsFileGetLine(
     cups_file_t * fp,
     char * buf,
     size_t buflen);
-
+

Arguments

-
NameDescription
fpCUPS file
+
@@ -372,17 +361,17 @@ cupsFileGetLine(

cupsFileGets()

Description

-

Get a CR and/or LF-terminated line.

+

Get a CR and/or LF-terminated line.

Syntax

-
-char *
+

+char *

 cupsFileGets(
     cups_file_t * fp,
     char * buf,
     size_t buflen);
-
+

Arguments

-
NameDescription
fpFile to read from
+
@@ -394,16 +383,16 @@ cupsFileGets(

cupsFileLock()

Description

-

Temporarily lock access to a file.

+

Temporarily lock access to a file.

Syntax

-
-int
+

+int

 cupsFileLock(
     cups_file_t * fp,
     int block);
-
+

Arguments

-
NameDescription
fpCUPS file
+
@@ -414,15 +403,15 @@ cupsFileLock(

cupsFileNumber()

Description

-

Return the file descriptor associated with a CUPS file.

+

Return the file descriptor associated with a CUPS file.

Syntax

-
-int
+

+int

 cupsFileNumber(
     cups_file_t * fp);
-
+

Arguments

-
NameDescription
fpFile to lock
+
@@ -432,16 +421,16 @@ cupsFileNumber(

cupsFileOpen()

Description

-

Open a CUPS file.

+

Open a CUPS file.

Syntax

-
-cups_file_t *
+

+cups_file_t *

 cupsFileOpen(
     const char * filename,
     const char * mode);
-
+

Arguments

-
NameDescription
fpCUPS file
+
@@ -452,16 +441,16 @@ cupsFileOpen(

cupsFileOpenFd()

Description

-

Open a CUPS file using a file descriptor.

+

Open a CUPS file using a file descriptor.

Syntax

-
-cups_file_t *
+

+cups_file_t *

 cupsFileOpenFd(
     int fd,
     const char * mode);
-
+

Arguments

-
NameDescription
filenameName of file
+
@@ -472,15 +461,15 @@ cupsFileOpenFd(

cupsFilePeekChar()

Description

-

Peek at the next character from a file.

+

Peek at the next character from a file.

Syntax

-
-int
+

+int

 cupsFilePeekChar(
     cups_file_t * fp);
-
+

Arguments

-
NameDescription
fdFile descriptor
+
@@ -490,17 +479,17 @@ cupsFilePeekChar(

cupsFilePrintf()

Description

-

Write a formatted string.

+

Write a formatted string.

Syntax

-
-int
+

+int

 cupsFilePrintf(
     cups_file_t * fp,
     const char * format,
     ...);
-
+

Arguments

-
NameDescription
fpCUPS file
+
@@ -512,16 +501,16 @@ cupsFilePrintf(

cupsFilePutChar()

Description

-

Write a character.

+

Write a character.

Syntax

-
-int
+

+int

 cupsFilePutChar(
     cups_file_t * fp,
     int c);
-
+

Arguments

-
NameDescription
fpCUPS file
+
@@ -532,16 +521,16 @@ cupsFilePutChar(

cupsFilePuts()

Description

-

Write a string.

+

Write a string.

Syntax

-
-int
+

+int

 cupsFilePuts(
     cups_file_t * fp,
     const char * s);
-
+

Arguments

-
NameDescription
fpCUPS file
+
@@ -552,17 +541,17 @@ cupsFilePuts(

cupsFileRead()

Description

-

Read from a file.

+

Read from a file.

Syntax

-
-ssize_t
+

+ssize_t

 cupsFileRead(
     cups_file_t * fp,
     char * buf,
     size_t bytes);
-
+

Arguments

-
NameDescription
fpCUPS file
+
@@ -574,15 +563,15 @@ cupsFileRead(

cupsFileRewind()

Description

-

Rewind a file.

+

Rewind a file.

Syntax

-
-off_t
+

+off_t

 cupsFileRewind(
     cups_file_t * fp);
-
+

Arguments

-
NameDescription
fpCUPS file
+
@@ -592,16 +581,16 @@ cupsFileRewind(

cupsFileSeek()

Description

-

Seek in a file.

+

Seek in a file.

Syntax

-
-off_t
+

+off_t

 cupsFileSeek(
     cups_file_t * fp,
     off_t pos);
-
+

Arguments

-
NameDescription
fpCUPS file
+
@@ -613,12 +602,12 @@ cupsFileSeek(

cupsFileStderr()

Description

Just reposition the current pointer, since we have the right -range...

+range...

Syntax

-
-cups_file_t *
+

+cups_file_t *

 cupsFileStderr(void);
-
+

Arguments

None.

Returns

@@ -626,12 +615,12 @@ cupsFileStderr(void);

cupsFileStdin()

Description

-

Open file descriptor 2...

+

Open file descriptor 2...

Syntax

-
-cups_file_t *
+

+cups_file_t *

 cupsFileStdin(void);
-
+

Arguments

None.

Returns

@@ -639,12 +628,12 @@ cupsFileStdin(void);

cupsFileStdout()

Description

-

Open file descriptor 0...

+

Open file descriptor 0...

Syntax

-
-cups_file_t *
+

+cups_file_t *

 cupsFileStdout(void);
-
+

Arguments

None.

Returns

@@ -652,15 +641,15 @@ cupsFileStdout(void);

cupsFileTell()

Description

-

Return the current file position.

+

Return the current file position.

Syntax

-
-off_t
+

+off_t

 cupsFileTell(
     cups_file_t * fp);
-
+

Arguments

-
NameDescription
fpCUPS file
+
@@ -670,15 +659,15 @@ cupsFileTell(

cupsFileUnlock()

Description

-

Unlock access to a file.

+

Unlock access to a file.

Syntax

-
-int
+

+int

 cupsFileUnlock(
     cups_file_t * fp);
-
+

Arguments

-
NameDescription
fpCUPS file
+
@@ -688,17 +677,17 @@ cupsFileUnlock(

cupsFileWrite()

Description

-

Write to a file.

+

Write to a file.

Syntax

-
-ssize_t
+

+ssize_t

 cupsFileWrite(
     cups_file_t * fp,
     const char * buf,
     size_t bytes);
-
+

Arguments

-
NameDescription
fpFile to lock
+
@@ -715,21 +704,22 @@ cupsFileWrite(

cups_dentry_s

Description

-

Directory entry type

+

Directory entry type

Definition

-
-struct cups_dentry_s
-{
-  struct stat fileinfo;
-  char filename[260];
-};
-
+

+struct cups_dentry_s
+{
+  struct stat fileinfo;
+  char filename[260];
+};

Members

-
NameDescription
fpCUPS file
+
- - + +
NameDescription
fileinfo File information
filename[260] File name
fileinfo File information +
filename[260] File name +

Types

@@ -741,26 +731,26 @@ struct cups_dentry_s

cups_dentry_t

Description

-

Directory entry type

+

Directory entry type

Definition

-
+

 typedef struct cups_dentry_s cups_dentry_t;
-
+

cups_dir_t

Description

-

Directory type

+

Directory type

Definition

-
+

 typedef struct _cups_dir_s cups_dir_t;
-
+

cups_file_t

Description

-

CUPS file type

+

CUPS file type

Definition

-
+

 typedef struct _cups_file_s cups_file_t;
-
+