DkmModule.FindDocuments Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| FindDocuments(DkmSourceFileId) |
Returns document objects from search parameters contained in the document query. If the symbol file does not contain a reference to this document the returned document object will be NULL (S_FALSE return code in native). The returned document objects must be explicitly closed by the caller when the caller is done with the document. Location constraint: API must be called from an IDE component (component level > 100,000). |
| FindDocuments(DkmWorkList, DkmSourceFileId, DkmCompletionRoutine<DkmFindDocumentsAsyncResult>) |
Returns document objects from search parameters contained in the document query. If the symbol file does not contain a reference to this document the returned document object will be NULL (S_FALSE return code in native). The returned document objects must be explicitly closed by the caller when the caller is done with the document. This method will append a new work item to the specified work list, and return once the work item has been appended. The actual processing of the work item is asynchronous. The caller will be notified that the request is complete through the completion routine. Location constraint: API must be called from an IDE component (component level > 100,000). |
FindDocuments(DkmSourceFileId)
Returns document objects from search parameters contained in the document query. If the symbol file does not contain a reference to this document the returned document object will be NULL (S_FALSE return code in native). The returned document objects must be explicitly closed by the caller when the caller is done with the document.
Location constraint: API must be called from an IDE component (component level > 100,000).
public:
cli::array <Microsoft::VisualStudio::Debugger::Symbols::DkmResolvedDocument ^> ^ FindDocuments(Microsoft::VisualStudio::Debugger::Symbols::DkmSourceFileId ^ SourceFileId);public Microsoft.VisualStudio.Debugger.Symbols.DkmResolvedDocument[] FindDocuments (Microsoft.VisualStudio.Debugger.Symbols.DkmSourceFileId SourceFileId);member this.FindDocuments : Microsoft.VisualStudio.Debugger.Symbols.DkmSourceFileId -> Microsoft.VisualStudio.Debugger.Symbols.DkmResolvedDocument[]Public Function FindDocuments (SourceFileId As DkmSourceFileId) As DkmResolvedDocument()Parameters
- SourceFileId
- DkmSourceFileId
[In] Identifies a source file and provides the information which a symbol handler could use to search a symbol file (PDB) for information on this source file.
Returns
[Out] A collection of the documents that matched the query.
Applies to
FindDocuments(DkmWorkList, DkmSourceFileId, DkmCompletionRoutine<DkmFindDocumentsAsyncResult>)
Returns document objects from search parameters contained in the document query. If the symbol file does not contain a reference to this document the returned document object will be NULL (S_FALSE return code in native). The returned document objects must be explicitly closed by the caller when the caller is done with the document.
This method will append a new work item to the specified work list, and return once the work item has been appended. The actual processing of the work item is asynchronous. The caller will be notified that the request is complete through the completion routine.
Location constraint: API must be called from an IDE component (component level > 100,000).
public:
void FindDocuments(Microsoft::VisualStudio::Debugger::DkmWorkList ^ WorkList, Microsoft::VisualStudio::Debugger::Symbols::DkmSourceFileId ^ SourceFileId, Microsoft::VisualStudio::Debugger::DkmCompletionRoutine<Microsoft::VisualStudio::Debugger::Symbols::DkmFindDocumentsAsyncResult> ^ CompletionRoutine);public void FindDocuments (Microsoft.VisualStudio.Debugger.DkmWorkList WorkList, Microsoft.VisualStudio.Debugger.Symbols.DkmSourceFileId SourceFileId, Microsoft.VisualStudio.Debugger.DkmCompletionRoutine<Microsoft.VisualStudio.Debugger.Symbols.DkmFindDocumentsAsyncResult> CompletionRoutine);member this.FindDocuments : Microsoft.VisualStudio.Debugger.DkmWorkList * Microsoft.VisualStudio.Debugger.Symbols.DkmSourceFileId * Microsoft.VisualStudio.Debugger.DkmCompletionRoutine<Microsoft.VisualStudio.Debugger.Symbols.DkmFindDocumentsAsyncResult> -> unitPublic Sub FindDocuments (WorkList As DkmWorkList, SourceFileId As DkmSourceFileId, CompletionRoutine As DkmCompletionRoutine(Of DkmFindDocumentsAsyncResult))Parameters
- WorkList
- DkmWorkList
WorkList to append the new work item to.
- SourceFileId
- DkmSourceFileId
[In] Identifies a source file and provides the information which a symbol handler could use to search a symbol file (PDB) for information on this source file.
- CompletionRoutine
- DkmCompletionRoutine<DkmFindDocumentsAsyncResult>
Routine to fire when the request is complete. If the request is successfully appended to the work list, this will always fire (including when the operation is canceled). This will never fire if appending the work item fails.