dyld-43.tar.gz
[apple/dyld.git] / doc / man / man3 / NSObjectFileImage_priv.3
1 .TH NSObjectFileImage 3 "July 9, 2003" "Apple Computer, Inc."
2 .SH NAME
3 NSObjectFileImage_priv \- programmatic interface for working with Mach-O files
4 .SH SYNOPSIS
5 .nf
6 .PP
7 #include <mach-o/dyld_priv.h>
8 .sp .5
9 extern enum DYLD_BOOL 
10 NSFindSectionAndOffsetInObjectFileImage(
11         NSObjectFileImage objectFileImage, 
12         unsigned long imageOffset,
13         const char** segmentName,       /* can be NULL */
14         const char** sectionName,       /* can be NULL */
15         unsigned long* sectionOffset)   /* can be NULL */
16 .sp .5
17 extern enum DYLD_BOOL 
18 NSHasModInitObjectFileImage(
19         NSObjectFileImage objectFileImage);
20 .fi
21 .SH DESCRIPTION
22 .PP
23 These routines are the programmatic interface for working with Mach-O files.
24 They bring the Mach-O file into memory and the API allows the file to
25 be inspected or loaded into the program.  On creation of an object file image
26 it is checked to insure it is a valid format and it is compatible with the host
27 machine's cpu architecture.
28 .PP
29 .PP
30 .I NSFindSectionAndOffsetInObjectFileImage
31 is supplied an imageOffset into an ObjectFileImage and returns 
32 via parameters the segment/section name and offset into that section of
33 that imageOffset.  It returns FALSE if the imageOffset is not 
34 in any section, otherwise TRUE.  You can used the resulting sectionOffset to
35 index into the data returned by NSGetSectionDataInObjectFileImage.
36 .PP
37 .I NSHasModInitObjectFileImage
38 returns TRUE if the NSObjectFileImage has any module initialization routines
39 and FALSE otherwise.
40
41 .SH ALSO SEE
42 NSObjectFileImage(3), NSModule(3), dyld(3)