The 0-based index of the embedded file. It must be a value from 0 to GetEmbeddedFileCount-1.
Example





In This Topic
GdPicture14 Namespace / GdPicturePDF Class / GetEmbeddedFileName Method

GetEmbeddedFileName Method (GdPicturePDF)

In This Topic
Gets the file name of an embedded file (the attachment's file name) within the currently loaded PDF document. You need to specify this attachment by its 0-based index.
Syntax
'Declaration

 


Public Function GetEmbeddedFileName( _

   ByVal FileIdx As Integer _

) As String
public string GetEmbeddedFileName( 

   int FileIdx

)
public function GetEmbeddedFileName( 

    FileIdx: Integer

): String; 
public function GetEmbeddedFileName( 

   FileIdx : int

) : String;
public: string* GetEmbeddedFileName( 

   int FileIdx

) 
public:

String^ GetEmbeddedFileName( 

   int FileIdx

)

Parameters

FileIdx
The 0-based index of the embedded file. It must be a value from 0 to GetEmbeddedFileCount-1.

Return Value

The file name of the embedded file. It is the attachment's current file name with its file extension.

The GetStat method can be subsequently used to determine if this method has been successful.

Remarks
This method is only allowed for use with non-encrypted documents.

It is recommend to use the GetStat method to identify the specific reason for the method's failure, if any.

Example
How to find out the file name of the first embedded file within the PDF document. 
Dim caption As String = "Example: GetEmbeddedFileName"

Dim gdpicturePDF As New GdPicturePDF()

If gdpicturePDF.LoadFromFile("TestPDFWithAttachment.pdf", False) = GdPictureStatus.OK Then

    Dim embeddedFileCount As Integer = gdpicturePDF.GetEmbeddedFileCount()

    If gdpicturePDF.GetStat() = GdPictureStatus.OK Then

        If embeddedFileCount = 0 Then

            MessageBox.Show("This PDF file does not contain embedded files.", caption)

        Else

            Dim fname As String = gdpicturePDF.GetEmbeddedFileName(0)

            Dim status As GdPictureStatus = gdpicturePDF.GetStat()

            If status = GdPictureStatus.OK Then

                MessageBox.Show("The file name of the first embedded file is: " + fname, caption)

            Else

                MessageBox.Show("The GetEmbeddedFileName() method has failed with the status: " + status.ToString(), caption)

            End If

        End If

    End If

Else

    MessageBox.Show("The file can't be loaded.", caption)

End If

gdpicturePDF.Dispose()
string caption = "Example: GetEmbeddedFileName";

GdPicturePDF gdpicturePDF = new GdPicturePDF();

if (gdpicturePDF.LoadFromFile("TestPDFWithAttachment.pdf", false) == GdPictureStatus.OK)

{

    int embeddedFileCount = gdpicturePDF.GetEmbeddedFileCount();

    if (gdpicturePDF.GetStat() == GdPictureStatus.OK)

    {

        if (embeddedFileCount == 0)

        {

            MessageBox.Show("This PDF file does not contain embedded files.", caption);

        }

        else

        {

            string fname = gdpicturePDF.GetEmbeddedFileName(0);

            GdPictureStatus status = gdpicturePDF.GetStat();

            if (status == GdPictureStatus.OK)

            {

                MessageBox.Show("The file name of the first embedded file is: " + fname, caption);

            }

            else

            {

                MessageBox.Show("The GetEmbeddedFileName() method has failed with the status: " + status.ToString(), caption);

            }

        }

    }

}

else

{

    MessageBox.Show("The file can't be loaded.", caption);

}

gdpicturePDF.Dispose();
See Also

Reference

GdPicturePDF Class
GdPicturePDF Members
GetEmbeddedFileCount Method
GetEmbeddedFileTitle Method
EmbedFile(String,String) Method
DeleteEmbeddedFile Method
LoadFromFile Method