Hide Table of Contents
CheckIn Method (IPDMWConnection)

Checks the specified closed document into the vault.

.NET Syntax

Visual Basic (Declaration) 
Function CheckIn( _
   ByVal filename As System.String, _
   ByVal project As System.String, _
   ByVal Number As System.String, _
   ByVal Description As System.String, _
   ByVal note As System.String, _
   ByVal i_revOption As PDMWRevisionOptionType, _
   ByVal Revision As System.String, _
   ByVal lifecycle As System.String, _
   ByVal RetainOwnership As System.Boolean, _
   ByVal References As System.Object _
) As PDMWDocument
Visual Basic (Usage) 
Dim instance As IPDMWConnection
Dim filename As System.String
Dim project As System.String
Dim Number As System.String
Dim Description As System.String
Dim note As System.String
Dim i_revOption As PDMWRevisionOptionType
Dim Revision As System.String
Dim lifecycle As System.String
Dim RetainOwnership As System.Boolean
Dim References As System.Object
Dim value As PDMWDocument
 
value = instance.CheckIn(filename, project, Number, Description, note, i_revOption, Revision, lifecycle, RetainOwnership, References)
C# 
PDMWDocument CheckIn( 
   System.string filename,
   System.string project,
   System.string Number,
   System.string Description,
   System.string note,
   PDMWRevisionOptionType i_revOption,
   System.string Revision,
   System.string lifecycle,
   System.bool RetainOwnership,
   System.object References
)
C++/CLI 
PDMWDocument^ CheckIn( 
&   System.String^ filename,
&   System.String^ project,
&   System.String^ Number,
&   System.String^ Description,
&   System.String^ note,
&   PDMWRevisionOptionType i_revOption,
&   System.String^ Revision,
&   System.String^ lifecycle,
&   System.bool RetainOwnership,
&   System.Object^ References
) 

Parameters

filename
Name of the closed document to check in
project

Name of the project to which the document belongs

Number
Document number
Description
Document description
note

Document notes

i_revOption

Revision option as defined in PDMWRevisionOptionType (see Remarks)

Revision
Document revision
lifecycle
Document lifecycle status
RetainOwnership
True to retain ownership of the document in the vault, false to not
References
Array of the full paths and filenames of any referenced documents to check in (see Remarks)

Return Value

IPDMWDocument object

Remarks

The document to check in must be closed before calling this method.

 

IMPORTANT: Because this method is dependent on pdmworks_libFNP.dll, you must ensure that your application can find this DLL. The simplest way for your application to find pdmworks_libFNP.dll is to add its location to the PATH environmental variable. See Microsoft Corp's Dynamic-Link Library Search Order for details.
 

This method only works on computers where both the SOLIDWORKS Workgroup PDM Contributor or Addin client software and SOLIDWORKS Workgroup PDM API DLL are installed.

 

This method can check in multiple file types, e.g., SOLIDWORKS, eDrawings, Microsoft Word, text, bitmap, PDF, etc.; however, only SOLIDWORKS documents saved in SOLIDWORKS 99 and later are supported by this method.

 

You must own the document before you can check it in. See IPDMWDocument::TakeOwnership for details about how to take ownership of a document.

If i_revOption is set to PDMWRevisionOptionType.Other, then the revision argument is used.

 

If checking in a document that references...

Then...

Non-Microsoft Word or Excel documents

The references argument is ignored. Instead, you must use IPDMWConnection::CheckIn to check in each referenced document individually.

Microsoft Word or Excel documents

The array of references is used.

 

See Also

Availability

SOLIDWORKS Workgroup PDM 2005 FCS


Provide feedback on this topic

SOLIDWORKS welcomes your feedback concerning the presentation, accuracy, and thoroughness of the documentation. Use the form below to send your comments and suggestions about this topic directly to our documentation team. The documentation team cannot answer technical support questions. Click here for information about technical support.

* Required

 
*Email:  
Subject:   Feedback on Help Topics
Page:   CheckIn Method (IPDMWConnection)
*Comment:  
*   I acknowledge I have read and I hereby accept the privacy policy under which my Personal Data will be used by Dassault Systèmes

Print Topic

Select the scope of content to print:

x

We have detected you are using a browser version older than Internet Explorer 7. For optimized display, we suggest upgrading your browser to Internet Explorer 7 or newer.

 Never show this message again
x

Web Help Content Version: API Help (English only) 2015 SP05

To disable Web help from within SOLIDWORKS and use local help instead, click Help > Use SOLIDWORKS Web Help.

To report problems encountered with the Web help interface and search, contact your local support representative. To provide feedback on individual help topics, use the “Feedback on this topic” link on the individual topic page.