'\" te
.\" Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved.
.TH project_walk 3PROJECT "7 Oct 2003" "SunOS 5.11" "Project Database Access Library Functions"
.SH NAME
project_walk \- visit active project IDs on current system  
.SH SYNOPSIS
.LP
.nf
cc [ \fIflag \&.\|.\|.\fR ] \fIfile\fR\&.\|.\|. \fB-lproject\fR [ \fIlibrary \&.\|.\|.\fR ] 
#include <project.h>

\fBint\fR \fBproject_walk\fR(\fBint (*\fR\fIcallback\fR)(\fBconst projid_t\fR \fIproject\fR,
     \fBvoid *\fR\fIwalk_data\fR), \fBvoid *\fR\fIinit_data\fR);
.fi

.SH DESCRIPTION
.sp
.LP
The \fBproject_walk()\fR function provides a mechanism for the application author to examine all active projects on the current system.  The \fIcallback\fR function provided by the application is given the ID of an active project at each invocation and can use the \fIwalk_data\fR to record its own state. The callback function should return non-zero if it encounters an error condition or attempts to terminate the walk prematurely; otherwise the callback function should return 0.
.SH RETURN VALUES
.sp
.LP
Upon successful completion, \fBproject_walk()\fR returns 0. It returns \(mi1 if the \fIcallback\fR function returned a non-zero value or if the walk encountered an error, in which case \fBerrno\fR is set to indicate the error.
.SH ERRORS
.sp
.LP
The \fBproject_walk()\fR function will fail if:
.sp
.ne 2
.mk
.na
\fB\fBENOMEM\fR\fR
.ad
.RS 10n
.rt  
There is insufficient memory available to set up the initial data for the walk.
.RE

.sp
.LP
Other returned error values are presumably caused by the \fIcallback\fR function.
.SH EXAMPLES
.LP
\fBExample 1 \fRCount the number of projects available on the system.
.sp
.LP
The following example counts the number of projects available on the system.

.sp
.in +2
.nf
#include <sys/types.h>
#include <project.h>
#include <stdio.h>

typedef struct wdata {
     uint_t count;
} wdata_t;

wdata_t total_count;

int
simple_callback(const projid_t p, void *pvt)
{
     wdata_t *w = (wdata_t *)pvt;
     w->count++;
     return (0);
}

\&...

total_count.count = 0;
errno = 0;
if ((n = project_walk(simple_callback, &total_count)) >= 0)
     (void) printf("count = %u\en", total_count.count);
.fi
.in -2

.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp

.sp
.TS
tab() box;
cw(2.75i) |cw(2.75i) 
lw(2.75i) |lw(2.75i) 
.
ATTRIBUTE TYPEATTRIBUTE VALUE
_
Interface StabilityCommitted
_
MT-LevelMT-Safe
.TE

.SH SEE ALSO
.sp
.LP
\fBgetprojid\fR(2), \fBlibproject\fR(3LIB), \fBsettaskid\fR(2), \fBattributes\fR(5)