tags:

views:

127

answers:

9

Hi kind of a newbie question.

So apparently this library is popular for this sort of thing:

http://extracting.codeplex.com/

When I download that all I get is a .dll

I can't find documentation on their api, I don't know what I'm supposed to do with this .dll (I know how to load in functions from DLLs and such, but how when I don't even know whats in it?), can someone help me out.

+4  A: 

start a new c# project. Open the add reference dialog and use the broswe tab, select the dll.

now open the object browser - you will see all the functions etc

edit: of course you can also download the source code from codeplex; always the ultimate form of documentation

pm100
You were first, by seconds, so you win ty
Joshua
While correct for this case, you don't see *all* the functions, etc.; you see all the *public* functions, etc.
Austin Salonen
+1  A: 

They have limited documentation on the codeplex site, available here.

I would recommend checking that documentation to see if it meets your needs, and asking any addition questions in their Discussions Page.

Reed Copsey
A: 

To use the functionality of the DLL from your project, right click on your project file in the Solution Explorer and choose "Add Reference..". You will be presented with a dialog to choose the reference you want to add. To choose the DLL from this library, browse to it from the Browse tab.

Once you've added the reference, you won't notice a whole lot of difference - all adding a reference does is give you access to the classes that are defined withing that DLL (called an "Assembly" in .NET terms). Think of it like getting a new set of "built-in" classes in your project that you can now use. You'll want to find some documentation or ask for help on the site to learn how to use these classes.

Ryan Brunner
A: 

if you are using visual studio, you can just include the dll into the reference folder of your project and then use the "using" keyword to include the library into your namespace ...

aggietech
A: 

If this is a .NET assembly, then reflector will tell you what classes and methods are available. You can also reference the DLL from a C# project and then press "ctrl-alt-j" to bring up the object browser to see that data inside of Visual Studio.

David Gladfelter
Reflector is really overkill if you're only concerned with the public interface to the assembly. No use confusing a new programmer with private / protected members that they won't be able to use anyway.
Ryan Brunner
@Ryan: you can just get the publicly viewable items in Reflector by changing the option in Tools -> Options -> Browser -> Visibility to Public Items Only.
adrianbanks
@Ryan, But if there's no documentation, then the dissassembly feature is the best thing since sliced bread.
David Gladfelter
Fair enough, but then you're essentially mimicking the functionality of the built-in object browser. It's a fine option for someone who's more advanced, but I wouldn't recommend it to someone who doesn't know what an assembly is.
Ryan Brunner
+2  A: 

There's a link on the same page pointing to the API documentation containing sample usage.

Darin Dimitrov
+1 for the obvious
Austin Salonen
A: 

You can download the source code from that page.

Look at the classes and namespaces. You can add a reference to the DLL to your project and add "using" with the namespace of the DLL to the top of any code files you need to use it in in order to have access to the classes.

Additionally you can look at some of the examples posted.

McAden
A: 

Load the dll into .net Reflector. This will list the contents of the dll and any code comments associated with the API.

Phillip Ngan