Help files

pull/10/head
David Hall 2017-11-30 13:11:10 -07:00 committed by GitHub
parent 6b45f2ab1d
commit 19c55c6ad4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
100 changed files with 152157 additions and 0 deletions

3592
docs/LastBuild.log Normal file

File diff suppressed because it is too large Load Diff

233
docs/SearchHelp.aspx Normal file
View File

@ -0,0 +1,233 @@
<%@ Page Language="C#" EnableViewState="False" %>
<script runat="server">
//===============================================================================================================
// System : Sandcastle Help File Builder
// File : SearchHelp.aspx
// Author : Eric Woodruff (Eric@EWoodruff.us)
// Updated : 05/15/2014
// Note : Copyright 2007-2015, Eric Woodruff, All rights reserved
// Compiler: Microsoft C#
//
// This file contains the code used to search for keywords within the help topics using the full-text index
// files created by the help file builder.
//
// This code is published under the Microsoft Public License (Ms-PL). A copy of the license should be
// distributed with the code. It can also be found at the project website: https://GitHub.com/EWSoftware/SHFB. This
// notice, the author's name, and all copyright notices must remain intact in all applications, documentation,
// and source files.
//
// Date Who Comments
// ==============================================================================================================
// 06/24/2007 EFW Created the code
// 02/17/2012 EFW Switched to JSON serialization to support websites that use something other than ASP.NET
// such as PHP.
// 05/15/2014 EFW Updated for use with the lightweight website presentation styles
//===============================================================================================================
/// <summary>
/// This class is used to track the results and their rankings
/// </summary>
private class Ranking
{
public string Filename, PageTitle;
public int Rank;
public Ranking(string file, string title, int rank)
{
Filename = file;
PageTitle = title;
Rank = rank;
}
}
/// <summary>
/// Render the search results
/// </summary>
/// <param name="writer">The writer to which the results are written</param>
protected override void Render(HtmlTextWriter writer)
{
JavaScriptSerializer jss = new JavaScriptSerializer();
string searchText, ftiFile;
char letter;
bool sortByTitle = false;
jss.MaxJsonLength = Int32.MaxValue;
// The keywords for which to search should be passed in the query string
searchText = this.Request.QueryString["Keywords"];
if(String.IsNullOrEmpty(searchText))
{
writer.Write("<strong>Nothing found</strong>");
return;
}
// An optional SortByTitle option can also be specified
if(this.Request.QueryString["SortByTitle"] != null)
sortByTitle = Convert.ToBoolean(this.Request.QueryString["SortByTitle"]);
List<string> keywords = this.ParseKeywords(searchText);
List<char> letters = new List<char>();
List<string> fileList;
Dictionary<string, List<long>> ftiWords, wordDictionary = new Dictionary<string,List<long>>();
// Load the file index
using(StreamReader sr = new StreamReader(Server.MapPath("fti/FTI_Files.json")))
{
fileList = jss.Deserialize<List<string>>(sr.ReadToEnd());
}
// Load the required word index files
foreach(string word in keywords)
{
letter = word[0];
if(!letters.Contains(letter))
{
letters.Add(letter);
ftiFile = Server.MapPath(String.Format(CultureInfo.InvariantCulture, "fti/FTI_{0}.json", (int)letter));
if(File.Exists(ftiFile))
{
using(StreamReader sr = new StreamReader(ftiFile))
{
ftiWords = jss.Deserialize<Dictionary<string, List<long>>>(sr.ReadToEnd());
}
foreach(string ftiWord in ftiWords.Keys)
wordDictionary.Add(ftiWord, ftiWords[ftiWord]);
}
}
}
// Perform the search and return the results as a block of HTML
writer.Write(this.Search(keywords, fileList, wordDictionary, sortByTitle));
}
/// <summary>
/// Split the search text up into keywords
/// </summary>
/// <param name="keywords">The keywords to parse</param>
/// <returns>A list containing the words for which to search</returns>
private List<string> ParseKeywords(string keywords)
{
List<string> keywordList = new List<string>();
string checkWord;
string[] words = Regex.Split(keywords, @"\W+");
foreach(string word in words)
{
checkWord = word.ToLower(CultureInfo.InvariantCulture);
if(checkWord.Length > 2 && !Char.IsDigit(checkWord[0]) && !keywordList.Contains(checkWord))
keywordList.Add(checkWord);
}
return keywordList;
}
/// <summary>
/// Search for the specified keywords and return the results as a block of HTML
/// </summary>
/// <param name="keywords">The keywords for which to search</param>
/// <param name="fileInfo">The file list</param>
/// <param name="wordDictionary">The dictionary used to find the words</param>
/// <param name="sortByTitle">True to sort by title, false to sort by ranking</param>
/// <returns>A block of HTML representing the search results</returns>
private string Search(List<string> keywords, List<string> fileInfo,
Dictionary<string, List<long>> wordDictionary, bool sortByTitle)
{
StringBuilder sb = new StringBuilder(10240);
Dictionary<string, List<long>> matches = new Dictionary<string, List<long>>();
List<long> occurrences;
List<int> matchingFileIndices = new List<int>(), occurrenceIndices = new List<int>();
List<Ranking> rankings = new List<Ranking>();
string filename, title;
string[] fileIndex;
bool isFirst = true;
int idx, wordCount, matchCount;
foreach(string word in keywords)
{
if(!wordDictionary.TryGetValue(word, out occurrences))
return "<strong>Nothing found</strong>";
matches.Add(word, occurrences);
occurrenceIndices.Clear();
// Get a list of the file indices for this match
foreach(long entry in occurrences)
occurrenceIndices.Add((int)(entry >> 16));
if(isFirst)
{
isFirst = false;
matchingFileIndices.AddRange(occurrenceIndices);
}
else
{
// After the first match, remove files that do not appear for
// all found keywords.
for(idx = 0; idx < matchingFileIndices.Count; idx++)
if(!occurrenceIndices.Contains(matchingFileIndices[idx]))
{
matchingFileIndices.RemoveAt(idx);
idx--;
}
}
}
if(matchingFileIndices.Count == 0)
return "<strong>Nothing found</strong>";
// Rank the files based on the number of times the words occurs
foreach(int index in matchingFileIndices)
{
// Split out the title, filename, and word count
fileIndex = fileInfo[index].Split('\x0');
title = fileIndex[0];
filename = fileIndex[1];
wordCount = Convert.ToInt32(fileIndex[2]);
matchCount = 0;
foreach(string word in keywords)
{
occurrences = matches[word];
foreach(long entry in occurrences)
if((int)(entry >> 16) == index)
matchCount += (int)(entry & 0xFFFF);
}
rankings.Add(new Ranking(filename, title, matchCount * 1000 / wordCount));
if(rankings.Count > 99)
break;
}
// Sort by rank in descending order or by page title in ascending order
rankings.Sort(delegate (Ranking x, Ranking y)
{
if(!sortByTitle)
return y.Rank - x.Rank;
return x.PageTitle.CompareTo(y.PageTitle);
});
// Format the file list and return the results
sb.Append("<ol>");
foreach(Ranking r in rankings)
sb.AppendFormat("<li><a href=\"{0}\" target=\"_blank\">{1}</a></li>", r.Filename, r.PageTitle);
sb.Append("</ol>");
if(rankings.Count < matchingFileIndices.Count)
sb.AppendFormat("<p>Omitted {0} more results</p>", matchingFileIndices.Count - rankings.Count);
return sb.ToString();
}
</script>

173
docs/SearchHelp.inc.php Normal file
View File

@ -0,0 +1,173 @@
<?
// Contributed to the Sandcastle Help File Builder project by Thomas Levesque
class Ranking
{
public $filename;
public $pageTitle;
public $rank;
function __construct($file, $title, $rank)
{
$this->filename = $file;
$this->pageTitle = $title;
$this->rank = $rank;
}
}
/// <summary>
/// Split the search text up into keywords
/// </summary>
/// <param name="keywords">The keywords to parse</param>
/// <returns>A list containing the words for which to search</returns>
function ParseKeywords($keywords)
{
$keywordList = array();
$words = preg_split("/[^\w]+/", $keywords);
foreach($words as $word)
{
$checkWord = strtolower($word);
$first = substr($checkWord, 0, 1);
if(strlen($checkWord) > 2 && !ctype_digit($first) && !in_array($checkWord, $keywordList))
{
array_push($keywordList, $checkWord);
}
}
return $keywordList;
}
/// <summary>
/// Search for the specified keywords and return the results as a block of
/// HTML.
/// </summary>
/// <param name="keywords">The keywords for which to search</param>
/// <param name="fileInfo">The file list</param>
/// <param name="wordDictionary">The dictionary used to find the words</param>
/// <param name="sortByTitle">True to sort by title, false to sort by
/// ranking</param>
/// <returns>A block of HTML representing the search results.</returns>
function Search($keywords, $fileInfo, $wordDictionary, $sortByTitle)
{
$sb = "<ol>";
$matches = array();
$matchingFileIndices = array();
$rankings = array();
$isFirst = true;
foreach($keywords as $word)
{
if (!array_key_exists($word, $wordDictionary))
{
return "<strong>Nothing found</strong>";
}
$occurrences = $wordDictionary[$word];
$matches[$word] = $occurrences;
$occurrenceIndices = array();
// Get a list of the file indices for this match
foreach($occurrences as $entry)
array_push($occurrenceIndices, ($entry >> 16));
if($isFirst)
{
$isFirst = false;
foreach($occurrenceIndices as $i)
{
array_push($matchingFileIndices, $i);
}
}
else
{
// After the first match, remove files that do not appear for
// all found keywords.
for($idx = 0; $idx < count($matchingFileIndices); $idx++)
{
if (!in_array($matchingFileIndices[$idx], $occurrenceIndices))
{
array_splice($matchingFileIndices, $idx, 1);
$idx--;
}
}
}
}
if(count($matchingFileIndices) == 0)
{
return "<strong>Nothing found</strong>";
}
// Rank the files based on the number of times the words occurs
foreach($matchingFileIndices as $index)
{
// Split out the title, filename, and word count
$fileIndex = explode("\x00", $fileInfo[$index]);
$title = $fileIndex[0];
$filename = $fileIndex[1];
$wordCount = intval($fileIndex[2]);
$matchCount = 0;
foreach($keywords as $words)
{
$occurrences = $matches[$word];
foreach($occurrences as $entry)
{
if(($entry >> 16) == $index)
$matchCount += $entry & 0xFFFF;
}
}
$r = new Ranking($filename, $title, $matchCount * 1000 / $wordCount);
array_push($rankings, $r);
if(count($rankings) > 99)
break;
}
// Sort by rank in descending order or by page title in ascending order
if($sortByTitle)
{
usort($rankings, "cmprankbytitle");
}
else
{
usort($rankings, "cmprank");
}
// Format the file list and return the results
foreach($rankings as $r)
{
$f = $r->filename;
$t = $r->pageTitle;
$sb .= "<li><a href=\"$f\" target=\"_blank\">$t</a></li>";
}
$sb .= "</ol";
if(count($rankings) < count($matchingFileIndices))
{
$c = count(matchingFileIndices) - count(rankings);
$sb .= "<p>Omitted $c more results</p>";
}
return $sb;
}
function cmprank($x, $y)
{
return $y->rank - $x->rank;
}
function cmprankbytitle($x, $y)
{
return strcmp($x->pageTitle, $y->pageTitle);
}
?>

58
docs/SearchHelp.php Normal file
View File

@ -0,0 +1,58 @@
<?
// Contributed to the Sandcastle Help File Builder project by Thomas Levesque
include("SearchHelp.inc.php");
$sortByTitle = false;
// The keywords for which to search should be passed in the query string
$searchText = $_GET["Keywords"];
if(empty($searchText))
{
?>
<strong>Nothing found</strong>
<?
return;
}
// An optional SortByTitle option can also be specified
if($_GET["SortByTitle"] == "true")
$sortByTitle = true;
$keywords = ParseKeywords($searchText);
$letters = array();
$wordDictionary = array();
// Load the file index
$json = file_get_contents("fti/FTI_Files.json");
$fileList = json_decode($json);
// Load the required word index files
foreach($keywords as $word)
{
$letter = substr($word, 0, 1);
if(!in_array($letter, $letters))
{
array_push($letters, $letter);
$ascii = ord($letter);
$ftiFile = "fti/FTI_$ascii.json";
if(file_exists($ftiFile))
{
$json = file_get_contents($ftiFile);
$ftiWords = json_decode($json, true);
foreach($ftiWords as $ftiWord => $val)
{
$wordDictionary[$ftiWord] = $val;
}
}
}
}
// Perform the search and return the results as a block of HTML
$results = Search($keywords, $fileList, $wordDictionary, $sortByTitle);
echo $results;
?>

2074
docs/Vanara.Core.xml Normal file

File diff suppressed because it is too large Load Diff

View File

@ -0,0 +1,890 @@
<?xml version="1.0" encoding="utf-8"?>
<doc>
<assembly>
<name>Vanara.PInvoke.AclUI</name>
</assembly>
<members>
<member name="T:Vanara.PInvoke.AclUI">
<summary>Platform invokable enumerated types, constants and functions from aclui.h</summary>
</member>
<member name="M:Vanara.PInvoke.AclUI.COMBINE_PAGE_ACTIVATION(Vanara.PInvoke.AclUI.SI_PAGE_TYPE,Vanara.PInvoke.AclUI.SI_PAGE_ACTIVATED)">
<summary>
Combines the <see cref="T:Vanara.PInvoke.AclUI.SI_PAGE_TYPE" /> and <see cref="T:Vanara.PInvoke.AclUI.SI_PAGE_ACTIVATED" /> types for use in the last parameter of <see cref="M:Vanara.PInvoke.AclUI.EditSecurityAdvanced(System.IntPtr,Vanara.PInvoke.AclUI.ISecurityInformation,System.UInt32)" /> method.
</summary>
<param name="pt">The <see cref="T:Vanara.PInvoke.AclUI.SI_PAGE_TYPE" /> value.</param>
<param name="pa">The <see cref="T:Vanara.PInvoke.AclUI.SI_PAGE_ACTIVATED" /> value.</param>
<returns>A combined value.</returns>
</member>
<member name="M:Vanara.PInvoke.AclUI.EditSecurity(System.IntPtr,Vanara.PInvoke.AclUI.ISecurityInformation)">
<summary>
The EditSecurity function displays a property sheet that contains a basic security property page. This property page enables the user to view and
edit the access rights allowed or denied by the ACEs in an object's DACL.
</summary>
<param name="hwnd">A handle to the window that owns the property sheet. This parameter can be NULL.</param>
<param name="psi">
A pointer to your implementation of the ISecurityInformation interface. The system calls the interface methods to retrieve information about the
object being edited and to return the user's input.
</param>
<returns>If the function succeeds, the return value is a nonzero value.</returns>
</member>
<member name="M:Vanara.PInvoke.AclUI.EditSecurityAdvanced(System.IntPtr,Vanara.PInvoke.AclUI.ISecurityInformation,System.UInt32)">
<summary>
The EditSecurityAdvanced function extends the EditSecurity function to include the security page type when displaying the property sheet that
contains a basic security property page. This property page enables the user to view and edit the access rights allowed or denied by the access
control entries (ACEs) in an object's discretionary access control list (DACL).
</summary>
<param name="hwnd">A handle to the window that owns the property sheet. This parameter can be NULL.</param>
<param name="psi">
A pointer to your implementation of the ISecurityInformation interface. The system calls the interface methods to retrieve information about the
object being edited and to return the user's input.
</param>
<param name="pageType">A value of the SI_PAGE_TYPE enumeration that indicates the page type on which to display the elevated access control editor.</param>
<returns>If the function succeeds, the return value is S_OK. If the function fails, any other HRESULT value indicates an error.</returns>
</member>
<member name="M:Vanara.PInvoke.AclUI.EditSecurityAdvanced(System.IntPtr,Vanara.PInvoke.AclUI.ISecurityInformation,Vanara.PInvoke.AclUI.SI_PAGE_TYPE,Vanara.PInvoke.AclUI.SI_PAGE_ACTIVATED)">
<summary>
The EditSecurityAdvanced function extends the EditSecurity function to include the security page type when displaying the property sheet that
contains a basic security property page. This property page enables the user to view and edit the access rights allowed or denied by the access
control entries (ACEs) in an object's discretionary access control list (DACL).
</summary>
<param name="hwnd">A handle to the window that owns the property sheet. This parameter can be NULL.</param>
<param name="psi">
A pointer to your implementation of the ISecurityInformation interface. The system calls the interface methods to retrieve information about the
object being edited and to return the user's input.
</param>
<param name="pageType">A value of the SI_PAGE_TYPE enumeration that indicates the page type on which to display the elevated access control editor.</param>
<param name="pageActivated">A value of the SI_PAGE_ACTIVATED enumeration that indicates the page type that is activated when the editor opens.</param>
<returns>If the function succeeds, the return value is S_OK. If the function fails, any other HRESULT value indicates an error.</returns>
</member>
<member name="T:Vanara.PInvoke.AclUI.EFFPERM_RESULT_LIST">
<summary>The EFFPERM_RESULT_LIST structure lists the effective permissions.</summary>
</member>
<member name="F:Vanara.PInvoke.AclUI.EFFPERM_RESULT_LIST.cObjectTypeListLength">
<summary>The number of elements in both the pObjectTypeList and pGrantedAccessList members.</summary>
</member>
<member name="F:Vanara.PInvoke.AclUI.EFFPERM_RESULT_LIST.fEvaluated">
<summary>Indicates if the effective permissions results have been evaluated.</summary>
</member>
<member name="F:Vanara.PInvoke.AclUI.EFFPERM_RESULT_LIST.pGrantedAccessList">
<summary>A pointer to an array of ACCESS_MASK values that specifies the access rights granted for each corresponding object type.</summary>
</member>
<member name="F:Vanara.PInvoke.AclUI.EFFPERM_RESULT_LIST.pObjectTypeList">
<summary>A pointer to an array of OBJECT_TYPE_LIST structures that specifies the properties and property sets for which access was evaluated.</summary>
</member>
<member name="T:Vanara.PInvoke.AclUI.IEffectivePermission">
<summary>
The IEffectivePermission interface provides a means to determine effective permission for a security principal on an object. The access control
editor uses this information to communicate the effective permission to the client.
</summary>
</member>
<member name="M:Vanara.PInvoke.AclUI.IEffectivePermission.GetEffectivePermission(System.Guid,Vanara.PInvoke.AdvApi32.PSID,System.String,System.IntPtr,Vanara.PInvoke.OBJECT_TYPE_LIST[]@,System.UInt32@,System.UInt32[]@,System.UInt32@)">
<summary>Returns the effective permission for an object type.</summary>
<param name="pguidObjectType">A GUID for the object type whose permission is being queried.</param>
<param name="pUserSid">A pointer to a SID structure that represents the security principal whose effective permission is being determined.</param>
<param name="pszServerName">A pointer to null-terminated wide character string that represents the server name.</param>
<param name="pSD">
A pointer to a SECURITY_DESCRIPTOR structure that represents the object's security descriptor. The security descriptor is used to perform the
access check.
</param>
<param name="ppObjectTypeList">
A pointer to a pointer to an OBJECT_TYPE_LIST structure that represents the array of object types in the object tree for the object. If an object
does not support property access, use the following technique to specify the value for the OBJECT_TYPE_LIST.
</param>
<param name="pcObjectTypeListLength">A pointer to a ULONG that receives the count of object types pointed to by ppObjectTypeList.</param>
<param name="ppGrantedAccessList">
A pointer to a pointer to an ACCESS_MASK that receives the array of granted access masks. The operating system will use LocalFree to free the
memory allocated for this parameter.
</param>
<param name="pcGrantedAccessListLength">
A pointer to a ULONG variable that receives the count of granted access masks pointed to by the ppGrantedAccessList parameter.
</param>
</member>
<member name="T:Vanara.PInvoke.AclUI.IEffectivePermission2">
<summary>
The IEffectivePermission2 interface provides a way to determine effective permissions for a security principal on an object in a way where the
principal's security context may be compounded with a device context or adjusted in other ways. Additionally, it determines the effective permissions
even when multiple security checks apply. The access control editor uses this information to communicate the effective permissions to the client.
</summary>
</member>
<member name="M:Vanara.PInvoke.AclUI.IEffectivePermission2.ComputeEffectivePermissionWithSecondarySecurity(Vanara.PInvoke.AdvApi32.PSID,Vanara.PInvoke.AdvApi32.PSID,System.String,Vanara.PInvoke.AclUI.SECURITY_OBJECT[],System.UInt32,Vanara.PInvoke.AdvApi32.TOKEN_GROUPS@,Vanara.PInvoke.Authz.AUTHZ_SID_OPERATION[],Vanara.PInvoke.AdvApi32.TOKEN_GROUPS@,Vanara.PInvoke.Authz.AUTHZ_SID_OPERATION[],Vanara.PInvoke.Authz.AUTHZ_SECURITY_ATTRIBUTES_INFORMATION@,Vanara.PInvoke.Authz.AUTHZ_SECURITY_ATTRIBUTE_OPERATION[],Vanara.PInvoke.Authz.AUTHZ_SECURITY_ATTRIBUTES_INFORMATION@,Vanara.PInvoke.Authz.AUTHZ_SECURITY_ATTRIBUTE_OPERATION[],Vanara.PInvoke.AclUI.EFFPERM_RESULT_LIST[])">
<summary>
The ComputeEffectivePermissionWithSecondarySecurity method computes the effective permissions for an object. It supports integrating secondary or
custom security policies. You may choose to provide this additional security information by implementing the ISecurityInformation4 interface.
This method supports compound identity, which is when a principal's access token contains user and device authorization information.
</summary>
<param name="pSid">A pointer to a SID structure that represents the security principal whose effective permission is being determined.</param>
<param name="pDeviceSid">
A pointer to a SID structure that represents the device from which the principal is accessing the object. If this is not NULL and you are using
the AuthzAccessCheck function to compute the effective permissions, then the device SID may be compounded with the pSid parameter by using the
AuthzInitializeCompoundContext function.
</param>
<param name="pszServerName">
The name of the server on which the object resides. This is the same name that was returned from the ISecurityInformation::GetObjectInformation method.
</param>
<param name="pSecurityObjects">
An array of security objects. This array is composed of objects that were deduced by the access control editor in addition to the ones returned
from the ISecurityInformation4::GetSecondarySecurity method.
</param>
<param name="dwSecurityObjectCount">
The number of security objects in the pSecurityObjects parameter, and the number of results lists in the pEffpermResultLists parameter.
</param>
<param name="pUserGroups">
A pointer to additional user groups that should be used to modify the security context which was initialized from the pSid parameter. If you are
using the AuthzAccessCheck function to compute the effective permissions, then the modification may be done by calling the AuthzModifySids
function using AuthzContextInfoGroupsSids as the SidClass parameter.
</param>
<param name="pAuthzUserGroupsOperations">
Pointer to an array of AUTHZ_SID_OPERATION structures that specify how the user groups in the authz context must be modified for each user group
in the pUserGroups argument. This array contains as many elements as the number of groups in the pUserGroups parameter.
</param>
<param name="pDeviceGroups">
A pointer to additional device groups that should be used to modify the security context which was initialized from the pSid parameter or one
that was created by compounding the contexts that were initialized from the pSid and pDeviceSid parameters. If you are using the AuthzAccessCheck
function to compute the effective permissions, then the modification may be done by calling the AuthzModifySids function using
AuthzContextInfoDeviceSids as the SidClass parameter.
</param>
<param name="pAuthzDeviceGroupsOperations">
Pointer to an array of AUTHZ_SID_OPERATION enumeration types that specify how the device groups in the authz context must be modified for each
device group in the pDeviceGroups argument. This array contains as many elements as the number of groups in the pDeviceGroups parameter.
</param>
<param name="pAuthzUserClaims">
Pointer to an AUTHZ_SECURITY_ATTRIBUTES_INFORMATION structure that contains the user claims context that should be used to modify the security
context that was initialized from the pSid parameter. If you are using the AuthzAccessCheck function to compute the effective permissions, then
the modification may be done by calling the AuthzModifyClaims function using AuthzContextInfoUserClaims as the ClaimClass parameter.
</param>
<param name="pAuthzUserClaimsOperations">
Pointer to an AUTHZ_SECURITY_ATTRIBUTE_OPERATION enumeration type that specifies the operations associated with the user claims context.
</param>
<param name="pAuthzDeviceClaims">
A pointer to the device claims context that should be used to modify the security context that was initialized from the pSid parameter or one
that was created by compounding the contexts that were initialized from the pSid and pDeviceSid parameters. This may be supplied by the caller,
even if the pDeviceSid parameter is not. If you are using the AuthzAccessCheck function to compute the effective permissions, then the
modification may be done by calling the AuthzModifyClaims function using AuthzContextInfoDeviceClaims as the ClaimClass parameter.
</param>
<param name="pAuthzDeviceClaimsOperations">
Pointer to an AUTHZ_SECURITY_ATTRIBUTE_OPERATION enumeration type that specifies the operations associated with the device claims context.
</param>
<param name="pEffpermResultLists">
A pointer to an array of the effective permissions results of type EFFPERM_RESULT_LIST. This array is dwSecurityObjectCount elements long. The
array is initialized by the caller and the implementation is expected to set all fields of each member in the array, indicating what access was
granted by the corresponding security object.
<para>
If a security object was considered, the fEvaluated member should be set to TRUE. In this case, the pObjectTypeList and pGrantedAccessList
members should both be cObjectTypeListLength elements long. The pObjectTypeList member must point to memory that is owned by the resource manager
and must remain valid until the EditSecurity function exits. The pGrantedAccessList member is freed by the caller by using the LocalFree
function. If the resource manager does not support object ACEs, then the pObjectTypeList member should point to the NULL GUID, the
cObjectTypeListLength member should be 1, and the pGrantedAccessList member should be a single DWORD.
</para></param>
<returns>
<markup>
<include item="SMCMissingTag">
<parameter>returns</parameter>
<parameter>M:Vanara.PInvoke.AclUI.IEffectivePermission2.ComputeEffectivePermissionWithSecondarySecurity(Vanara.PInvoke.AdvApi32.PSID,Vanara.PInvoke.AdvApi32.PSID,System.String,Vanara.PInvoke.AclUI.SECURITY_OBJECT[],System.UInt32,Vanara.PInvoke.AdvApi32.TOKEN_GROUPS@,Vanara.PInvoke.Authz.AUTHZ_SID_OPERATION[],Vanara.PInvoke.AdvApi32.TOKEN_GROUPS@,Vanara.PInvoke.Authz.AUTHZ_SID_OPERATION[],Vanara.PInvoke.Authz.AUTHZ_SECURITY_ATTRIBUTES_INFORMATION@,Vanara.PInvoke.Authz.AUTHZ_SECURITY_ATTRIBUTE_OPERATION[],Vanara.PInvoke.Authz.AUTHZ_SECURITY_ATTRIBUTES_INFORMATION@,Vanara.PInvoke.Authz.AUTHZ_SECURITY_ATTRIBUTE_OPERATION[],Vanara.PInvoke.AclUI.EFFPERM_RESULT_LIST[])</parameter>
</include>
</markup>
</returns>
</member>
<member name="T:Vanara.PInvoke.AclUI.ISecurityInformation">
<summary>
The ISecurityInformation interface enables the access control editor to communicate with the caller of the CreateSecurityPage and EditSecurity
functions. The editor calls the interface methods to retrieve information that is used to initialize its pages and to determine the editing options
available to the user. The editor also calls the interface methods to pass the user's input back to the application.
</summary>
</member>
<member name="M:Vanara.PInvoke.AclUI.ISecurityInformation.GetAccessRights(System.Guid,System.Int32,Vanara.PInvoke.AclUI.SI_ACCESS[]@,System.UInt32@,System.UInt32@)">
<summary>
The GetAccessRights method requests information about the access rights that can be controlled for a securable object. The access control editor
calls this method to retrieve display strings and other information used to initialize the property pages.
</summary>
<param name="guidObject">
A pointer to a GUID structure that identifies the type of object for which access rights are being requested. If this parameter is NULL or a
pointer to GUID_NULL, return the access rights for the object being edited. Otherwise, the GUID identifies a child object type returned by the
ISecurityInformation::GetInheritTypes method. The GUID corresponds to the InheritedObjectType member of an object-specific ACE.
</param>
<param name="dwFlags">
A set of bit flags that indicate the property page being initialized. This value is zero if the basic security page is being initialized.
Otherwise, it is a combination of the following values.
</param>
<param name="access">
A pointer to an array of SI_ACCESS structures. The array must include one entry for each access right. You can specify access rights that apply
to the object itself, as well as object-specific access rights that apply only to a property set or property on the object.
</param>
<param name="access_count">A pointer to ULONG that indicates the number of entries in the ppAccess array.</param>
<param name="DefaultAccess">
A pointer to ULONG that indicates the zero-based index of the array entry that contains the default access rights. The access control editor uses
this entry as the initial access rights in a new ACE.
</param>
</member>
<member name="M:Vanara.PInvoke.AclUI.ISecurityInformation.GetInheritTypes(Vanara.PInvoke.AclUI.SI_INHERIT_TYPE[]@,System.UInt32@)">
<summary>
The GetInheritTypes method requests information about how ACEs can be inherited by child objects. For more information, see ACE Inheritance.
</summary>
<param name="InheritType">
A pointer to a variable you should set to a pointer to an array of SI_INHERIT_TYPE structures. The array should include one entry for each
combination of inheritance flags and child object type that you support.
</param>
<param name="InheritTypesCount">A pointer to a variable that you should set to indicate the number of entries in the ppInheritTypes array.</param>
</member>
<member name="M:Vanara.PInvoke.AclUI.ISecurityInformation.GetObjectInformation(Vanara.PInvoke.AclUI.SI_OBJECT_INFO@)">
<summary>
The GetObjectInformation method requests information that the access control editor uses to initialize its pages and to determine the editing
options available to the user.
</summary>
<param name="object_info">
A pointer to an SI_OBJECT_INFO structure. Your implementation must fill this structure to pass information back to the access control editor.
</param>
</member>
<member name="M:Vanara.PInvoke.AclUI.ISecurityInformation.GetSecurity(Vanara.PInvoke.SECURITY_INFORMATION,System.IntPtr@,System.Boolean)">
<summary>
The GetSecurity method requests a security descriptor for the securable object whose security descriptor is being edited. The access control
editor calls this method to retrieve the object's current or default security descriptor.
</summary>
<param name="RequestInformation">
A set of SECURITY_INFORMATION bit flags that indicate the parts of the security descriptor being requested. This parameter can be a combination
of the following values.
</param>
<param name="SecurityDescriptor">
A pointer to a variable that your implementation must set to a pointer to the object's security descriptor. The security descriptor must include
the components requested by the RequestedInformation parameter.
<para>The system calls the LocalFree function to free the returned pointer.</para></param>
<param name="fDefault">
If this parameter is TRUE, ppSecurityDescriptor should return an application-defined default security descriptor for the object. The access
control editor uses this default security descriptor to reinitialize the property page.
<para>
The access control editor sets this parameter to TRUE only if the user clicks the Default button. The Default button is displayed only if you set
the SI_RESET flag in the ISecurityInformation::GetObjectInformation method. If no default security descriptor is available, do not set the
SI_RESET flag.
</para><para>If this flag is FALSE, ppSecurityDescriptor should return the object's current security descriptor.</para></param>
</member>
<member name="M:Vanara.PInvoke.AclUI.ISecurityInformation.MapGeneric(System.Guid,System.SByte@,System.UInt32@)">
<summary>
The MapGeneric method requests that the generic access rights in an access mask be mapped to their corresponding standard and specific access
rights. For more information about generic, standard, and specific access rights, see Access Rights and Access Masks.
</summary>
<param name="guidObjectType">
A pointer to a GUID structure that identifies the type of object to which the access mask applies. If this member is NULL or a pointer to
GUID_NULL, the access mask applies to the object itself.
</param>
<param name="AceFlags">A pointer to the AceFlags member of the ACE_HEADER structure from the ACE whose access mask is being mapped.</param>
<param name="Mask">
A pointer to an access mask that contains the generic access rights to map. Your implementation must map the generic access rights to the
corresponding standard and specific access rights for the specified object type.
</param>
</member>
<member name="M:Vanara.PInvoke.AclUI.ISecurityInformation.PropertySheetPageCallback(System.IntPtr,Vanara.PInvoke.AclUI.PropertySheetCallbackMessage,Vanara.PInvoke.AclUI.SI_PAGE_TYPE)">
<summary>
The PropertySheetPageCallback method notifies an EditSecurity or CreateSecurityPage caller that an access control editor property page is being
created or destroyed.
</summary>
<param name="hwnd">If uMsg is PSPCB_SI_INITDIALOG, hwnd is a handle to the property page dialog box. Otherwise, hwnd is NULL.</param>
<param name="uMsg">Identifies the message being received.</param>
<param name="uPage">
A value from the SI_PAGE_TYPE enumeration type that indicates the type of access control editor property page being created or destroyed.
</param>
</member>
<member name="M:Vanara.PInvoke.AclUI.ISecurityInformation.SetSecurity(Vanara.PInvoke.SECURITY_INFORMATION,System.IntPtr)">
<summary>
The SetSecurity method provides a security descriptor containing the security information the user wants to apply to the securable object. The
access control editor calls this method when the user clicks Okay or Apply.
</summary>
<param name="RequestInformation">A set of SECURITY_INFORMATION bit flags that indicate the parts of the security descriptor to set.</param>
<param name="SecurityDescriptor">
A pointer to a security descriptor containing the new security information. Do not assume the security descriptor is in self-relative form; it
can be either absolute or self-relative.
</param>
</member>
<member name="T:Vanara.PInvoke.AclUI.ISecurityInformation2">
<summary>
The ISecurityInformation2 interface enables the access control editor to obtain information from the client that is not provided by the
ISecurityInformation interface. The client does not need to implement ISecurityInformation2 unless the default behavior of the access control editor
is unsuitable for the client.
</summary>
</member>
<member name="M:Vanara.PInvoke.AclUI.ISecurityInformation2.IsDaclCanonical(System.IntPtr)">
<summary>
The IsDaclCanonical method determines whether the ACEs contained in the specified DACL structure are ordered according to the definition of DACL
ordering implemented by the client.
</summary>
<param name="pDacl">A pointer to a discretionary ACL structure initialized by InitializeAcl.</param>
<returns>
Returns TRUE if the ACEs contained in the specified DACL structure are ordered according to the definition of DACL ordering implemented by the
client. Returns FALSE if the ACEs are not ordered correctly.
</returns>
</member>
<member name="M:Vanara.PInvoke.AclUI.ISecurityInformation2.LookupSids(System.UInt32,Vanara.PInvoke.AdvApi32.PSID[],System.IntPtr@)">
<summary>The LookupSids method returns the common names corresponding to each of the elements in the specified list of SIDs.</summary>
<param name="cSids">The number of pointers to SID structures pointed to by rgpSids.</param>
<param name="rgpSids">A pointer to an array of pointers to SID structures.</param>
<param name="ppdo">
A pointer to a pointer to a returned data transfer object that contains the common names of the SIDs. Optionally, this parameter also returns the
user principal name (UPN) of the SIDs in the rgpSids parameter. The data transfer object is a SID_INFO structure.
</param>
</member>
<member name="T:Vanara.PInvoke.AclUI.ISecurityInformation3">
<summary>
The ISecurityInformation3 interface provides methods necessary for displaying an elevated access control editor when a user clicks the Edit button on
an access control editor page that displays an image of a shield on that Edit button. The image of a shield is displayed on the Edit button when the
access control editor is launched by a process with a token that lacks permission to save changes to the object being edited.
</summary>
</member>
<member name="M:Vanara.PInvoke.AclUI.ISecurityInformation3.GetFullResourceName">
<summary>
The GetFullResourceName method retrieves the full path and file name of the object associated with the access control editor that is displayed by
calling the OpenElevatedEditor method.
</summary>
<returns>The full path and file name of the object for which permissions are to be edited.</returns>
</member>
<member name="M:Vanara.PInvoke.AclUI.ISecurityInformation3.OpenElevatedEditor(System.IntPtr,Vanara.PInvoke.AclUI.SI_PAGE_TYPE)">
<summary>
The OpenElevatedEditor method opens an access control editor when a user clicks the Edit button on an access control editor page that displays an
image of a shield on that Edit button. The image of a shield is displayed when the access control editor is launched by a process with a token
that lacks permission to save changes to the object being edited.
</summary>
<param name="hWnd">The parent window of the access control editor.</param>
<param name="uPage">A value of the SI_PAGE_TYPE enumeration that indicates the page type on which to display the elevated access control editor.</param>
</member>
<member name="T:Vanara.PInvoke.AclUI.ISecurityInformation4">
<summary>
The ISecurityInformation4 interface enables the resource manager to provide additional information when computing effective permissions using the
IEffectivePermission2 interface.
</summary>
</member>
<member name="M:Vanara.PInvoke.AclUI.ISecurityInformation4.GetSecondarySecurity(Vanara.PInvoke.AclUI.SECURITY_OBJECT[]@,System.UInt32@)">
<summary>The GetSecondarySecurity method returns additional security contexts that may impact access to the resource.</summary>
<param name="pSecurityObjects">
An array of SECURITY_OBJECT structures that contain the secondary security objects associated with the resources that are set on success. The
array is owned by the caller and is freed by using the LocalFree function. The pwszName member is also freed by using LocalFree. If the cbData or
cbData2 members of the SECURITY_OBJECT structure are not zero, then the caller must free the corresponding pData or pData2 by using LocalFree. If
either of those members are zero, then the corresponding pData and pData2 members are owned by the resource manager and must remain valid until
the EditSecurity function returns.
</param>
<param name="pSecurityObjectCount">The number of security objects in the pSecurityObjects parameter that are set on success.</param>
</member>
<member name="T:Vanara.PInvoke.AclUI.ISecurityObjectTypeInfo">
<summary>
The ISecurityObjectTypeInfo interface provides a means of determining the source of inherited access control entries (ACEs) in discretionary access
control lists (DACLs) and system access control lists (SACLs). The access control editor uses this information to communicate the inheritance source
to the client.
</summary>
</member>
<member name="M:Vanara.PInvoke.AclUI.ISecurityObjectTypeInfo.GetInheritSource(System.Int32,System.IntPtr,Vanara.PInvoke.AdvApi32.INHERITED_FROM[]@)">
<summary>
The GetInheritSource method provides a means of determining the source of inherited access control entries (ACEs) in discretionary access control
lists (DACLs) and system access control lists (SACLs).
</summary>
<param name="si">A SECURITY_INFORMATION structure that represents the security information of the object.</param>
<param name="pACL">A pointer to an ACL structure that represents the access control list (ACL) of the object.</param>
<param name="ppInheritArray">
A pointer to a pointer to an INHERITED_FROM structure that receives an array of INHERITED_FROM structures. The length of this array is the same
as the number of ACEs in the ACL referenced by pACL. Each INHERITED_FROM entry in ppInheritArray provides inheritance information for the
corresponding ACE entry in pACL.
</param>
</member>
<member name="T:Vanara.PInvoke.AclUI.PropertySheetCallbackMessage">
<summary>Messages sent from property sheet.</summary>
</member>
<member name="F:Vanara.PInvoke.AclUI.PropertySheetCallbackMessage.PSPCB_ADDREF">
<summary>Add reference.</summary>
</member>
<member name="F:Vanara.PInvoke.AclUI.PropertySheetCallbackMessage.PSPCB_RELEASE">
<summary>Release reference.</summary>
</member>
<member name="F:Vanara.PInvoke.AclUI.PropertySheetCallbackMessage.PSPCB_CREATE">
<summary>Create page.</summary>
</member>
<member name="F:Vanara.PInvoke.AclUI.PropertySheetCallbackMessage.PSPCB_SI_INITDIALOG">
<summary>Initialize dialog.</summary>
</member>
<member name="T:Vanara.PInvoke.AclUI.SECURITY_OBJECT">
<summary>The SECURITY_OBJECT structure contains the security object information.</summary>
</member>
<member name="F:Vanara.PInvoke.AclUI.SECURITY_OBJECT.cbData">
<summary>
The size, in bytes, of the data pointed to by the pData member. This may be zero if pData contains the data, such as when the data is an IUnknown
interface pointer, a handle, or data specific to the resource manager that can be stored in pData directly without a memory allocation.
</summary>
</member>
<member name="F:Vanara.PInvoke.AclUI.SECURITY_OBJECT.cbData2">
<summary>
The size, in bytes, of the data pointed to by the pData2 member. This may be zero if pData2 contains the data, such as when the data is an
IUnknown interface pointer, a handle, or data specific to the resource manager that can be stored in pData2 directly without a memory allocation.
</summary>
</member>
<member name="F:Vanara.PInvoke.AclUI.SECURITY_OBJECT.fWellKnown">
<summary>TRUE if the security object represents one of the well-know security objects listed in the Id member.</summary>
</member>
<member name="F:Vanara.PInvoke.AclUI.SECURITY_OBJECT.Id">
<summary>
The identifier for the security object's type. If the fWellKnown member is FALSE, then the Id member has no special significance other than to
help resource managers distinguish it from other classes of security objects. If the fWellKnown member is TRUE, then the Id member is one of the
following and the entire structure follows the corresponding representation.
</summary>
</member>
<member name="F:Vanara.PInvoke.AclUI.SECURITY_OBJECT.pData">
<summary>A pointer to the security data.</summary>
</member>
<member name="F:Vanara.PInvoke.AclUI.SECURITY_OBJECT.pData2">
<summary>A pointer to the additional security data.</summary>
</member>
<member name="F:Vanara.PInvoke.AclUI.SECURITY_OBJECT.pwszName">
<summary>A pointer to the name.</summary>
</member>
<member name="T:Vanara.PInvoke.AclUI.SECURITY_OBJECT_ID">
<summary>
<markup>
<include item="SMCMissingTag">
<parameter>summary</parameter>
<parameter>T:Vanara.PInvoke.AclUI.SECURITY_OBJECT_ID</parameter>
</include>
</markup>
</summary>
</member>
<member name="F:Vanara.PInvoke.AclUI.SECURITY_OBJECT_ID.SECURITY_OBJECT_ID_OBJECT_SD">
<summary>
The security descriptor of the resource.
<para>If Id is set to this value, then pData points to a security descriptor and cbData is the number of bytes in pData.</para><para>pData2 is NULL and cbData2 is 0.</para></summary>
</member>
<member name="F:Vanara.PInvoke.AclUI.SECURITY_OBJECT_ID.SECURITY_OBJECT_ID_SHARE">
<summary>
The security descriptor of a network share.
<para>
If Id is set to this value, then pData points to the ISecurityInformation interface of an object that represents the security context of the share.
</para><para>
If the security descriptor is not yet available, then pData2 must be a handle to a waitable object that is signaled when the security descriptor
is ready when the GetSecondarySecurity method returns S_FALSE. The waitable object should be created by the CreateEvent function. In this case,
cbData2 is 0.
</para><para>This identifier is only applicable to file system objects.</para></summary>
</member>
<member name="F:Vanara.PInvoke.AclUI.SECURITY_OBJECT_ID.SECURITY_OBJECT_ID_CENTRAL_POLICY">
<summary>
The security descriptor of a central access policy.
<para>
If Id is set to this value, then pData points to the security descriptor with an empty DACL, an owner, group, and attribute access control
entries (ACEs) that match the resource's owner, group, and attributes as well as a SCOPE_SECURITY_INFORMATION_ACE that contains the central
policy's ID. cbData is set to the number of bytes in pData.
</para><para>pData2 is NULL and cbData2 is 0.</para><para>
The security descriptor is constructed to allow computing effective permissions to correctly determine when access is limited by the central
policy and higher detail of the central access rule cannot be determined. This is used when a central access policy that applies to a resource
cannot be resolved into its elemental central access rules.
</para></summary>
</member>
<member name="F:Vanara.PInvoke.AclUI.SECURITY_OBJECT_ID.SECURITY_OBJECT_ID_CENTRAL_ACCESS_RULE">
<summary>
The security descriptor of a central access rule.
<para>
If Id is set to this value, then pData points to the security descriptor with an owner, group, and attribute ACEs that match the resource's
owner, group, and attributes, and a discretionary access control list (DACL) that matches the central access rule's DACL. cbData is set to the
number of bytes in pData.
</para><para>
In addition, pData2 points to a security descriptor with a DACL that contains a conditional ACE that grants 0x1 to Everyone if the resource
condition from the central access rule evaluates to TRUE. cbData2 is set to the number of bytes in pData2.
</para><para>
The security descriptor is constructed to allow computing effective permissions to determine when access is limited by the central access policy
at the highest detail. That is, access is limited by pointing to a central policy rule.
</para></summary>
</member>
<member name="T:Vanara.PInvoke.AclUI.SI_ACCESS">
<summary>
Class contains information about an access right or default access mask for a securable object. The <see cref="M:Vanara.PInvoke.AclUI.ISecurityInformation.GetAccessRights(System.Guid,System.Int32,Vanara.PInvoke.AclUI.SI_ACCESS[]@,System.UInt32@,System.UInt32@)" />
method uses this class to specify information that the access control editor uses to initialize its property pages.
</summary>
</member>
<member name="M:Vanara.PInvoke.AclUI.SI_ACCESS.#ctor(System.UInt32,System.String,Vanara.PInvoke.AclUI.SI_ACCESS_Flags,System.Nullable{System.Guid})">
<summary>Initializes a new instance of the <see cref="T:Vanara.PInvoke.AclUI.SI_ACCESS" /> class.</summary>
<param name="mask">The access mask.</param>
<param name="name">The display name.</param>
<param name="flags">The access flags.</param>
<param name="objType">Type of the object.</param>
</member>
<member name="F:Vanara.PInvoke.AclUI.SI_ACCESS.dwFlags">
<summary>A set of <see cref="T:Vanara.PInvoke.AclUI.SI_ACCESS_Flags" /> that indicate where the access right is displayed.</summary>
</member>
<member name="F:Vanara.PInvoke.AclUI.SI_ACCESS.mask">
<summary>
A bitmask that specifies the access right described by this structure. The mask can contain any combination of standard and specific rights, but
should not contain generic rights such as GENERIC_ALL.
</summary>
</member>
<member name="P:Vanara.PInvoke.AclUI.SI_ACCESS.ObjectTypeId">
<summary>
The type of object. This member can be <see cref="F:System.Guid.Empty" />. The GUID corresponds to the InheritedObjectType member of an object-specific ACE.
</summary>
</member>
<member name="F:Vanara.PInvoke.AclUI.SI_ACCESS.pguid">
<summary>
A pointer to a GUID structure that identifies the type of object to which the access right or default access mask applies. The GUID can identify
a property set or property on the object, or a type of child object that can be contained by the object. If this member points to GUID_NULL, the
access right applies to the object itself.
</summary>
</member>
<member name="F:Vanara.PInvoke.AclUI.SI_ACCESS.pszName">
<summary>A display string that describes the access right.</summary>
</member>
<member name="T:Vanara.PInvoke.AclUI.SI_ACCESS_Flags">
<summary>Flags that indicate where the access right is displayed or whether other containers or objects can inherit the access right.</summary>
</member>
<member name="F:Vanara.PInvoke.AclUI.SI_ACCESS_Flags.SI_ACCESS_SPECIFIC">
<summary>The access right is displayed on the advanced security pages.</summary>
</member>
<member name="F:Vanara.PInvoke.AclUI.SI_ACCESS_Flags.SI_ACCESS_GENERAL">
<summary>The access right is displayed on the basic security page.</summary>
</member>
<member name="F:Vanara.PInvoke.AclUI.SI_ACCESS_Flags.SI_ACCESS_CONTAINER">
<summary>
Indicates an access right that applies only to containers. If this flag is set, the access right is displayed on the basic security page only if
the <see cref="M:Vanara.PInvoke.AclUI.ISecurityInformation.GetObjectInformation(Vanara.PInvoke.AclUI.SI_OBJECT_INFO@)" /> specifies the SI_CONTAINER flag.
</summary>
</member>
<member name="F:Vanara.PInvoke.AclUI.SI_ACCESS_Flags.SI_ACCESS_PROPERTY">
<summary>Indicates a property-specific access right.</summary>
</member>
<member name="F:Vanara.PInvoke.AclUI.SI_ACCESS_Flags.CONTAINER_INHERIT_ACE">
<summary>Other containers that are contained by the primary object inherit the entry.</summary>
</member>
<member name="F:Vanara.PInvoke.AclUI.SI_ACCESS_Flags.INHERITED_ACE">
<summary>
The ACE is inherited. Operations that change the security on a tree of objects may modify inherited ACEs without changing ACEs that were directly
applied to the object.
</summary>
</member>
<member name="F:Vanara.PInvoke.AclUI.SI_ACCESS_Flags.INHERIT_ONLY_ACE">
<summary>
The ACE does not apply to the primary object to which the ACL is attached, but objects contained by the primary object inherit the entry.
</summary>
</member>
<member name="F:Vanara.PInvoke.AclUI.SI_ACCESS_Flags.NO_PROPAGATE_INHERIT_ACE">
<summary>The ObjectInheritAce and ContainerInheritAce bits are not propagated to an inherited ACE.</summary>
</member>
<member name="F:Vanara.PInvoke.AclUI.SI_ACCESS_Flags.OBJECT_INHERIT_ACE">
<summary>Noncontainer objects contained by the primary object inherit the entry.</summary>
</member>
<member name="T:Vanara.PInvoke.AclUI.SI_INHERIT_Flags">
<summary>Indicate the types of ACEs that can be inherited in a <see cref="T:Vanara.PInvoke.AclUI.SI_INHERIT_TYPE" /> structure.</summary>
</member>
<member name="F:Vanara.PInvoke.AclUI.SI_INHERIT_Flags.CONTAINER_INHERIT_ACE">
<summary>The specified object type can inherit ACEs that have the <c>CONTAINER_INHERIT_ACE</c> flag set.</summary>
</member>
<member name="F:Vanara.PInvoke.AclUI.SI_INHERIT_Flags.INHERIT_ONLY_ACE">
<summary>The specified object type can inherit ACEs that have the <c>INHERIT_ONLY_ACE</c> flag set.</summary>
</member>
<member name="F:Vanara.PInvoke.AclUI.SI_INHERIT_Flags.OBJECT_INHERIT_ACE">
<summary>The specified object type can inherit ACEs that have the <c>OBJECT_INHERIT_ACE</c> flag set.</summary>
</member>
<member name="T:Vanara.PInvoke.AclUI.SI_INHERIT_TYPE">
<summary>
Contains information about how access control entries (ACEs) can be inherited by child objects. The <see cref="M:Vanara.PInvoke.AclUI.ISecurityInformation.GetInheritTypes(Vanara.PInvoke.AclUI.SI_INHERIT_TYPE[]@,System.UInt32@)" />
method uses this structure to specify display strings that the access control editor uses to initialize its property pages.
</summary>
</member>
<member name="M:Vanara.PInvoke.AclUI.SI_INHERIT_TYPE.#ctor(System.Guid,Vanara.PInvoke.AclUI.SI_INHERIT_Flags,System.String)">
<summary>Initializes a new instance of the <see cref="T:Vanara.PInvoke.AclUI.SI_INHERIT_TYPE" /> struct.</summary>
<param name="childObjectType">Type of the child object.</param>
<param name="flags">The inheritance flags.</param>
<param name="name">The display name.</param>
</member>
<member name="M:Vanara.PInvoke.AclUI.SI_INHERIT_TYPE.#ctor(Vanara.PInvoke.AclUI.SI_INHERIT_Flags,System.String)">
<summary>Initializes a new instance of the <see cref="T:Vanara.PInvoke.AclUI.SI_INHERIT_TYPE" /> struct.</summary>
<param name="flags">The inheritance flags.</param>
<param name="name">The display name.</param>
</member>
<member name="P:Vanara.PInvoke.AclUI.SI_INHERIT_TYPE.ChildObjectTypeId">
<summary>
The type of child object. This member can be <see cref="F:System.Guid.Empty" />. The GUID corresponds to the InheritedObjectType member of an
object-specific ACE.
</summary>
</member>
<member name="F:Vanara.PInvoke.AclUI.SI_INHERIT_TYPE.dwFlags">
<summary>
A set of <see cref="T:Vanara.PInvoke.AclUI.SI_INHERIT_Flags" /> that indicate the types of ACEs that can be inherited by the <see cref="P:Vanara.PInvoke.AclUI.SI_INHERIT_TYPE.ChildObjectTypeId" />. These flags
correspond to the AceFlags member of an ACE_HEADER structure.
</summary>
</member>
<member name="F:Vanara.PInvoke.AclUI.SI_INHERIT_TYPE.pguid">
<summary>
A pointer to a GUID structure that identifies the type of child object. This member can be a pointer to GUID_NULL. The GUID corresponds to the
InheritedObjectType member of an object-specific ACE.
</summary>
</member>
<member name="F:Vanara.PInvoke.AclUI.SI_INHERIT_TYPE.pszName">
<summary>A display string that describes the child object.</summary>
</member>
<member name="T:Vanara.PInvoke.AclUI.SI_OBJECT_INFO">
<summary>
The SI_OBJECT_INFO structure is used by the ISecurityInformation::GetObjectInformation method to specify information used to initialize the access
control editor.
</summary>
</member>
<member name="M:Vanara.PInvoke.AclUI.SI_OBJECT_INFO.#ctor(Vanara.PInvoke.AclUI.SI_OBJECT_INFO_Flags,System.String,System.String,System.String,System.Nullable{System.Guid})">
<summary>Initializes a new instance of the <see cref="T:Vanara.PInvoke.AclUI.SI_OBJECT_INFO" /> struct.</summary>
<param name="flags">A set of bit flags that determine the editing options available to the user.</param>
<param name="objectName">Names the object being edited.</param>
<param name="serverName">Names the computer on which to look up account names and SIDs.</param>
<param name="pageTitle">The title of the basic security property page.</param>
<param name="guidObject">The unique identifier for the object.</param>
</member>
<member name="F:Vanara.PInvoke.AclUI.SI_OBJECT_INFO.dwFlags">
<summary>A set of bit flags that determine the editing options available to the user.</summary>
</member>
<member name="F:Vanara.PInvoke.AclUI.SI_OBJECT_INFO.guidObjectType">
<summary>A GUID for the object. This member is ignored unless the SI_OBJECT_GUID flag is set in dwFlags.</summary>
</member>
<member name="F:Vanara.PInvoke.AclUI.SI_OBJECT_INFO.hInstance">
<summary>
Identifies a module that contains string resources to be used in the property sheet. The ISecurityInformation::GetAccessRights and
ISecurityInformation::GetInheritTypes methods can specify string resource identifiers for display names.
</summary>
</member>
<member name="P:Vanara.PInvoke.AclUI.SI_OBJECT_INFO.IsContainer">
<summary>Gets a value indicating whether this instance is container.</summary>
</member>
<member name="F:Vanara.PInvoke.AclUI.SI_OBJECT_INFO.pszObjectName">
<summary>
A pointer to a null-terminated, Unicode string that names the object being edited. This name appears in the title of the advanced security
property sheet and any error message boxes displayed by the access control editor. The access control editor does not free this pointer.
</summary>
</member>
<member name="F:Vanara.PInvoke.AclUI.SI_OBJECT_INFO.pszPageTitle">
<summary>
A pointer to a null-terminated, Unicode string used as the title of the basic security property page. This member is ignored unless the
SI_PAGE_TITLE flag is set in dwFlags. If the page title is not provided, a default title is used. The access control editor does not free this pointer.
</summary>
</member>
<member name="F:Vanara.PInvoke.AclUI.SI_OBJECT_INFO.pszServerName">
<summary>
A pointer to a null-terminated, Unicode string that names the computer on which to look up account names and SIDs. This value can be NULL to
specify the local computer. The access control editor does not free this pointer.
</summary>
</member>
<member name="M:Vanara.PInvoke.AclUI.SI_OBJECT_INFO.ToString">
<summary>Returns a <see cref="T:System.String" /> that represents this instance.</summary>
<returns>A <see cref="T:System.String" /> that represents this instance.</returns>
</member>
<member name="T:Vanara.PInvoke.AclUI.SI_OBJECT_INFO_Flags">
<summary>A set of bit flags that determine the editing options available to the user.</summary>
</member>
<member name="F:Vanara.PInvoke.AclUI.SI_OBJECT_INFO_Flags.SI_ADVANCED">
<summary>
The Advanced button is displayed on the basic security property page. If the user clicks this button, the system displays an advanced security
property sheet that enables advanced editing of the discretionary access control list (DACL) of the object.
</summary>
</member>
<member name="F:Vanara.PInvoke.AclUI.SI_OBJECT_INFO_Flags.SI_AUDITS_ELEVATION_REQUIRED">
<summary>
If this flag is set, a shield is displayed on the Edit button of the advanced Auditing pages. For NTFS objects, this flag is requested when the
user does not have READ_CONTROL or ACCESS_SYSTEM_SECURITY access. Windows Server 2003 and Windows XP: This flag is not supported.
</summary>
</member>
<member name="F:Vanara.PInvoke.AclUI.SI_OBJECT_INFO_Flags.SI_CONTAINER">
<summary>
Indicates that the object is a container. If this flag is set, the access control editor enables the controls relevant to the inheritance of
permissions onto child objects.
</summary>
</member>
<member name="F:Vanara.PInvoke.AclUI.SI_OBJECT_INFO_Flags.SI_EDIT_ALL">
<summary>Combines the EditPerms, EditOwner, and EditAudit flags.</summary>
</member>
<member name="F:Vanara.PInvoke.AclUI.SI_OBJECT_INFO_Flags.SI_EDIT_AUDITS">
<summary>
If this flag is set and the user clicks the Advanced button, the system displays an advanced security property sheet that includes an Auditing
property page for editing the object's SACL.
</summary>
</member>
<member name="F:Vanara.PInvoke.AclUI.SI_OBJECT_INFO_Flags.SI_EDIT_EFFECTIVE">
<summary>If this flag is set, the Effective Permissions page is displayed.</summary>
</member>
<member name="F:Vanara.PInvoke.AclUI.SI_OBJECT_INFO_Flags.SI_EDIT_OWNER">
<summary>
If this flag is set and the user clicks the Advanced button, the system displays an advanced security property sheet that includes an Owner
property page for changing the object's owner.
</summary>
</member>
<member name="F:Vanara.PInvoke.AclUI.SI_OBJECT_INFO_Flags.SI_EDIT_PERMS">
<summary>
This is the default value. The basic security property page always displays the controls for basic editing of the object's DACL. To disable these
controls, set the ReadOnly flag.
</summary>
</member>
<member name="F:Vanara.PInvoke.AclUI.SI_OBJECT_INFO_Flags.SI_EDIT_PROPERTIES">
<summary>
If this flag is set, the system enables controls for editing ACEs that apply to the object's property sets and properties. These controls are
available only on the property sheet displayed when the user clicks the Advanced button.
</summary>
</member>
<member name="F:Vanara.PInvoke.AclUI.SI_OBJECT_INFO_Flags.SI_MAY_WRITE">
<summary>
Indicates that the access control editor cannot read the DACL but might be able to write to the DACL. If a call to the
ISecurityInformation::GetSecurity method returns AccessDenied, the user can try to add a new ACE, and a more appropriate warning is displayed.
</summary>
</member>
<member name="F:Vanara.PInvoke.AclUI.SI_OBJECT_INFO_Flags.SI_NO_ACL_PROTECT">
<summary>
If this flag is set, the access control editor hides the check box that allows inheritable ACEs to propagate from the parent object to this
object. If this flag is not set, the check box is visible. The check box is clear if the SE_DACL_PROTECTED flag is set in the object's security
descriptor. In this case, the object's DACL is protected from being modified by inheritable ACEs. If the user clears the check box, any inherited
ACEs in the security descriptor are deleted or converted to noninherited ACEs. Before proceeding with this conversion, the system displays a
warning message box to confirm the change.
</summary>
</member>
<member name="F:Vanara.PInvoke.AclUI.SI_OBJECT_INFO_Flags.SI_NO_ADDITIONAL_PERMISSION">
<summary>If this flag is set, the access control editor hides the Special Permissions tab on the Advanced Security Settings page.</summary>
</member>
<member name="F:Vanara.PInvoke.AclUI.SI_OBJECT_INFO_Flags.SI_NO_TREE_APPLY">
<summary>
If this flag is set, the access control editor hides the check box that controls the NO_PROPAGATE_INHERIT_ACE flag. This flag is relevant only
when the Advanced flag is also set.
</summary>
</member>
<member name="F:Vanara.PInvoke.AclUI.SI_OBJECT_INFO_Flags.SI_OBJECT_GUID">
<summary>
When set, indicates that the ObjectGuid property is valid. This is set in comparisons with object-specific ACEs in determining whether the ACE
applies to the current object.
</summary>
</member>
<member name="F:Vanara.PInvoke.AclUI.SI_OBJECT_INFO_Flags.SI_OWNER_ELEVATION_REQUIRED">
<summary>
If this flag is set, a shield is displayed on the Edit button of the advanced Owner page. For NTFS objects, this flag is requested when the user
does not have WRITE_OWNER access. This flag is valid only if the owner page is requested. Windows Server 2003 and Windows XP: This flag is not supported.
</summary>
</member>
<member name="F:Vanara.PInvoke.AclUI.SI_OBJECT_INFO_Flags.SI_OWNER_READONLY">
<summary>
If this flag is set, the user cannot change the owner of the object. Set this flag if EditOwner is set but the user does not have permission to
change the owner.
</summary>
</member>
<member name="F:Vanara.PInvoke.AclUI.SI_OBJECT_INFO_Flags.SI_OWNER_RECURSE">
<summary>
Combine this flag with Container to display a check box on the owner page that indicates whether the user intends the new owner to be applied to
all child objects as well as the current object. The access control editor does not perform the recursion.
</summary>
</member>
<member name="F:Vanara.PInvoke.AclUI.SI_OBJECT_INFO_Flags.SI_PAGE_TITLE">
<summary>
If this flag is set, the Title property value is used as the title of the basic security property page. Otherwise, a default title is used.
</summary>
</member>
<member name="F:Vanara.PInvoke.AclUI.SI_OBJECT_INFO_Flags.SI_PERMS_ELEVATION_REQUIRED">
<summary>
If this flag is set, an image of a shield is displayed on the Edit button of the simple and advanced Permissions pages. For NTFS objects, this
flag is requested when the user does not have READ_CONTROL or WRITE_DAC access. Windows Server 2003 and Windows XP: This flag is not supported.
</summary>
</member>
<member name="F:Vanara.PInvoke.AclUI.SI_OBJECT_INFO_Flags.SI_READONLY">
<summary>
If this flag is set, the editor displays the object's security information, but the controls for editing the information are disabled. This flag
cannot be combined with the ViewOnly flag.
</summary>
</member>
<member name="F:Vanara.PInvoke.AclUI.SI_OBJECT_INFO_Flags.SI_RESET">
<summary>
If this flag is set, the Default button is displayed. If the user clicks this button, the access control editor calls the
IAccessControlEditorDialogProvider.DefaultSecurity to retrieve an application-defined default security descriptor. The access control editor uses
this security descriptor to reinitialize the property sheet, and the user is allowed to apply the change or cancel.
</summary>
</member>
<member name="F:Vanara.PInvoke.AclUI.SI_OBJECT_INFO_Flags.SI_RESET_DACL">
<summary>When set, this flag displays the Reset Defaults button on the Permissions page.</summary>
</member>
<member name="F:Vanara.PInvoke.AclUI.SI_OBJECT_INFO_Flags.SI_RESET_DACL_TREE">
<summary>
When set, this flag displays the Reset permissions on all child objects and enable propagation of inheritable permissions check box in the
Permissions page of the Access Control Settings window. This function does not reset the permissions and enable propagation of inheritable permissions.
</summary>
</member>
<member name="F:Vanara.PInvoke.AclUI.SI_OBJECT_INFO_Flags.SI_RESET_OWNER">
<summary>When set, this flag displays the Reset Defaults button on the Owner page.</summary>
</member>
<member name="F:Vanara.PInvoke.AclUI.SI_OBJECT_INFO_Flags.SI_RESET_SACL">
<summary>When set, this flag displays the Reset Defaults button on the Auditing page.</summary>
</member>
<member name="F:Vanara.PInvoke.AclUI.SI_OBJECT_INFO_Flags.SI_RESET_SACL_TREE">
<summary>
When set, this flag displays the Reset auditing entries on all child objects and enables propagation of the inheritable auditing entries check
box in the Auditing page of the Access Control Settings window. This function does not reset the permissions and enable propagation of
inheritable permissions.
</summary>
</member>
<member name="F:Vanara.PInvoke.AclUI.SI_OBJECT_INFO_Flags.SI_SERVER_IS_DC">
<summary>
Set this flag if the computer defined by the ServerName property is known to be a domain controller. If this flag is set, the domain name is
included in the scope list of the Add Users and Groups dialog box. Otherwise, the pszServerName computer is used to determine the scope list of
the dialog box.
</summary>
</member>
<member name="F:Vanara.PInvoke.AclUI.SI_OBJECT_INFO_Flags.SI_VIEW_ONLY">
<summary>View Only.</summary>
</member>
<member name="T:Vanara.PInvoke.AclUI.SI_PAGE_ACTIVATED">
<summary>Page types used by the new advanced ACL UI</summary>
</member>
<member name="F:Vanara.PInvoke.AclUI.SI_PAGE_ACTIVATED.SI_SHOW_DEFAULT">
<summary></summary>
</member>
<member name="F:Vanara.PInvoke.AclUI.SI_PAGE_ACTIVATED.SI_SHOW_PERM_ACTIVATED">
<summary></summary>
</member>
<member name="F:Vanara.PInvoke.AclUI.SI_PAGE_ACTIVATED.SI_SHOW_AUDIT_ACTIVATED">
<summary></summary>
</member>
<member name="F:Vanara.PInvoke.AclUI.SI_PAGE_ACTIVATED.SI_SHOW_OWNER_ACTIVATED">
<summary></summary>
</member>
<member name="F:Vanara.PInvoke.AclUI.SI_PAGE_ACTIVATED.SI_SHOW_EFFECTIVE_ACTIVATED">
<summary></summary>
</member>
<member name="F:Vanara.PInvoke.AclUI.SI_PAGE_ACTIVATED.SI_SHOW_SHARE_ACTIVATED">
<summary></summary>
</member>
<member name="F:Vanara.PInvoke.AclUI.SI_PAGE_ACTIVATED.SI_SHOW_CENTRAL_POLICY_ACTIVATED">
<summary></summary>
</member>
<member name="T:Vanara.PInvoke.AclUI.SI_PAGE_TYPE">
<summary>Values that indicate the types of property pages in an access control editor property sheet.</summary>
</member>
<member name="F:Vanara.PInvoke.AclUI.SI_PAGE_TYPE.SI_PAGE_PERM">
<summary>Permissions page.</summary>
</member>
<member name="F:Vanara.PInvoke.AclUI.SI_PAGE_TYPE.SI_PAGE_ADVPERM">
<summary>Advanced page.</summary>
</member>
<member name="F:Vanara.PInvoke.AclUI.SI_PAGE_TYPE.SI_PAGE_AUDIT">
<summary>Audit page.</summary>
</member>
<member name="F:Vanara.PInvoke.AclUI.SI_PAGE_TYPE.SI_PAGE_OWNER">
<summary>Owner page.</summary>
</member>
<member name="F:Vanara.PInvoke.AclUI.SI_PAGE_TYPE.SI_PAGE_EFFECTIVE">
<summary>Effective Rights page.</summary>
</member>
<member name="F:Vanara.PInvoke.AclUI.SI_PAGE_TYPE.SI_PAGE_TAKEOWNERSHIP">
<summary>Take Ownership page.</summary>
</member>
<member name="F:Vanara.PInvoke.AclUI.SI_PAGE_TYPE.SI_PAGE_SHARE">
<summary>Share page.</summary>
</member>
<member name="T:Vanara.PInvoke.AclUI.SID_INFO">
<summary>
The SID_INFO structure contains the list of common names corresponding to the SID structures returned by ISecurityInformation2::LookupSids. It is a
member of the SID_INFO_LIST structure.
</summary>
</member>
<member name="F:Vanara.PInvoke.AclUI.SID_INFO.pSid">
<summary>A pointer to a SID structure that identifies one of the SIDs passed into ISecurityInformation2::LookupSids.</summary>
</member>
<member name="F:Vanara.PInvoke.AclUI.SID_INFO.pwzClass">
<summary>
A pointer to a string describing the SID structure as either a user or a group. The possible values of this string are as follows: "Computer",
"Group", or "User"
</summary>
</member>
<member name="F:Vanara.PInvoke.AclUI.SID_INFO.pwzCommonName">
<summary>A pointer to a string containing the common name corresponding to the SID structure specified in pSid.</summary>
</member>
<member name="F:Vanara.PInvoke.AclUI.SID_INFO.pwzUPN">
<summary>
A pointer to the user principal name (UPN) corresponding to the SID structure specified in pSid. If a UPN has not been designated for the SID
structure, the value of this parameter is NULL.
</summary>
</member>
</members>
</doc>

File diff suppressed because it is too large Load Diff

View File

@ -0,0 +1,391 @@
<?xml version="1.0" encoding="utf-8"?>
<doc>
<assembly>
<name>Vanara.PInvoke.CredUI</name>
</assembly>
<members>
<member name="T:Vanara.PInvoke.CredUI">
<summary>
<markup>
<include item="SMCMissingTag">
<parameter>summary</parameter>
<parameter>T:Vanara.PInvoke.CredUI</parameter>
</include>
</markup>
</summary>
</member>
<member name="F:Vanara.PInvoke.CredUI.CRED_MAX_DOMAIN_TARGET_NAME_LENGTH">
<summary>
<markup>
<include item="SMCMissingTag">
<parameter>summary</parameter>
<parameter>F:Vanara.PInvoke.CredUI.CRED_MAX_DOMAIN_TARGET_NAME_LENGTH</parameter>
</include>
</markup>
</summary>
</member>
<member name="F:Vanara.PInvoke.CredUI.CRED_MAX_USERNAME_LENGTH">
<summary>
<markup>
<include item="SMCMissingTag">
<parameter>summary</parameter>
<parameter>F:Vanara.PInvoke.CredUI.CRED_MAX_USERNAME_LENGTH</parameter>
</include>
</markup>
</summary>
</member>
<member name="M:Vanara.PInvoke.CredUI.CredPackAuthenticationBuffer(Vanara.PInvoke.CredUI.CredPackFlags,System.IntPtr,System.IntPtr,System.IntPtr,System.Int32@)">
<summary>
The CredPackAuthenticationBuffer function converts a string user name and password into an authentication buffer.
<para>Beginning with Windows 8 and Windows Server 2012, the CredPackAuthenticationBuffer function converts an identity credential into an authentication buffer, which is a SEC_WINNT_AUTH_IDENTITY_EX2 structure. This buffer can be passed to LsaLogonUser, AcquireCredentialsHandle, or other identity provider interfaces.</para></summary>
<param name="dwFlags">Specifies how the credential should be packed.</param>
<param name="pszUserName">A pointer to a null-terminated string that specifies the user name to be converted. For domain users, the string must be in the following format:
<para>DomainName\UserName</para><para>For online identities, if the credential is a plaintext password, the user name format is ProviderName\UserName. If the credential is a SEC_WINNT_AUTH_IDENTITY_EX2 structure, the user name is an encoded string that is the UserName parameter output of a function call to SspiEncodeAuthIdentityAsStrings.</para><para>For smart card or certificate credentials, the user name is an encoded string that is the output of a function call to CredMarshalCredential with the CertCredential option.</para><para><c>Windows Server 2008 R2, Windows 7, Windows Server 2008 and Windows Vista:</c> Online identities are not supported.</para></param>
<param name="pszPassword">A pointer to a null-terminated string that specifies the password to be converted.
<para>For SEC_WINNT_AUTH_IDENTITY_EX2 credentials, the password is an encoded string that is in the ppszPackedCredentialsString output of a function call to SspiEncodeAuthIdentityAsStrings.</para><para>For smart card credentials, this is the smart card PIN.</para><para><c>Windows Server 2008 R2, Windows 7, Windows Server 2008 and Windows Vista:</c> Online identities are not supported.</para></param>
<param name="pPackedCredentials">A pointer to an array of bytes that, on output, receives the packed authentication buffer. This parameter can be NULL to receive the required buffer size in the pcbPackedCredentials parameter.</param>
<param name="pcbPackedCredentials">A pointer to a DWORD value that specifies the size, in bytes, of the pPackedCredentials buffer. On output, if the buffer is not of sufficient size, specifies the required size, in bytes, of the pPackedCredentials buffer.</param>
<returns>TRUE if the function succeeds; otherwise, FALSE. For extended error information, call the GetLastError function.</returns>
</member>
<member name="F:Vanara.PInvoke.CredUI.CREDUI_MAX_CAPTION_LENGTH">
<summary>
<markup>
<include item="SMCMissingTag">
<parameter>summary</parameter>
<parameter>F:Vanara.PInvoke.CredUI.CREDUI_MAX_CAPTION_LENGTH</parameter>
</include>
</markup>
</summary>
</member>
<member name="F:Vanara.PInvoke.CredUI.CREDUI_MAX_DOMAIN_TARGET_LENGTH">
<summary>
<markup>
<include item="SMCMissingTag">
<parameter>summary</parameter>
<parameter>F:Vanara.PInvoke.CredUI.CREDUI_MAX_DOMAIN_TARGET_LENGTH</parameter>
</include>
</markup>
</summary>
</member>
<member name="F:Vanara.PInvoke.CredUI.CREDUI_MAX_MESSAGE_LENGTH">
<summary>
<markup>
<include item="SMCMissingTag">
<parameter>summary</parameter>
<parameter>F:Vanara.PInvoke.CredUI.CREDUI_MAX_MESSAGE_LENGTH</parameter>
</include>
</markup>
</summary>
</member>
<member name="F:Vanara.PInvoke.CredUI.CREDUI_MAX_PASSWORD_LENGTH">
<summary>
<markup>
<include item="SMCMissingTag">
<parameter>summary</parameter>
<parameter>F:Vanara.PInvoke.CredUI.CREDUI_MAX_PASSWORD_LENGTH</parameter>
</include>
</markup>
</summary>
</member>
<member name="F:Vanara.PInvoke.CredUI.CREDUI_MAX_USERNAME_LENGTH">
<summary>
<markup>
<include item="SMCMissingTag">
<parameter>summary</parameter>
<parameter>F:Vanara.PInvoke.CredUI.CREDUI_MAX_USERNAME_LENGTH</parameter>
</include>
</markup>
</summary>
</member>
<member name="M:Vanara.PInvoke.CredUI.CredUIConfirmCredentials(System.String,System.Boolean)">
<summary>
The CredUIConfirmCredentials function is called after CredUIPromptForCredentials or CredUICmdLinePromptForCredentials, to confirm the validity of the credential harvested. CredUIConfirmCredentials must be called if the CREDUI_FLAGS_EXPECT_CONFIRMATION flag was passed to the "prompt" function, either CredUIPromptForCredentials or CredUICmdLinePromptForCredentials, and the "prompt" function returned NO_ERROR.
<para>After calling the "prompt" function and before calling CredUIConfirmCredentials, the caller must determine whether the credentials are actually valid by using the credentials to access the resource specified by pszTargetName. The results of that validation test are passed to CredUIConfirmCredentials in the bConfirm parameter.</para></summary>
<param name="targetName">Pointer to a null-terminated string that contains the name of the target for the credentials, typically a domain or server application name. This must be the same value passed as pszTargetName to CredUIPromptForCredentials or CredUICmdLinePromptForCredentials</param>
<param name="confirm">Specifies whether the credentials returned from the prompt function are valid. If TRUE, the credentials are stored in the credential manager as defined by CredUIPromptForCredentials or CredUICmdLinePromptForCredentials. If FALSE, the credentials are not stored and various pieces of memory are cleaned up.</param>
<returns>Status of the operation is returned. The caller can check this status to determine whether the credential confirm operation succeeded. Most applications ignore this status code because the application's connection to the resource has already been done. The operation can fail because the credential was not found on the list of credentials awaiting confirmation, or because the attempt to write or delete the credential failed. Failure to find the credential on the list can occur because the credential was never queued or as a result of too many credentials being queued. Up to five credentials can be queued before older ones are discarded as newer ones are queued.</returns>
</member>
<member name="M:Vanara.PInvoke.CredUI.CredUIParseUserName(System.String,System.Text.StringBuilder,System.Int32,System.Text.StringBuilder,System.Int32)">
<summary>
The CredUIParseUserName function extracts the domain and user account name from a fully qualified user name.
</summary>
<param name="pszUserName">Pointer to a null-terminated string that contains the user name to be parsed. The name must be in UPN or down-level format, or a certificate. Typically, pszUserName is received from the CredUIPromptForCredentials or CredUICmdLinePromptForCredentials.</param>
<param name="pszUser">Pointer to a null-terminated string that receives the user account name.</param>
<param name="ulUserMaxChars">Maximum number of characters to write to the pszUser string including the terminating null character.
<note>CREDUI_MAX_USERNAME_LENGTH does NOT include the terminating null character.</note></param>
<param name="pszDomain">Pointer to a null-terminated string that receives the domain name. If pszUserName specifies a certificate, pszDomain will be NULL.</param>
<param name="ulDomainMaxChars">Maximum number of characters to write to the pszDomain string including the terminating null character.
<note>CREDUI_MAX_DOMAIN_TARGET_LENGTH does NOT include the terminating null character.</note></param>
<returns>Status of the operation is returned.</returns>
</member>
<member name="M:Vanara.PInvoke.CredUI.CredUIPromptForCredentials(Vanara.PInvoke.CredUI.CREDUI_INFO@,System.String,System.IntPtr,System.Int32,System.Text.StringBuilder,System.Int32,System.Text.StringBuilder,System.Int32,System.Boolean@,Vanara.PInvoke.CredUI.CredentialsDialogOptions)">
<summary>
The CredUIPromptForCredentials function creates and displays a configurable dialog box that accepts credentials information from a user.
<para>Applications that target Windows Vista or Windows Server 2008 should call CredUIPromptForWindowsCredentials instead of this function, for the following reasons:</para><list type="bullet"><item><term>CredUIPromptForWindowsCredentials is consistent with the current Windows user interface.</term></item><item><term>CredUIPromptForWindowsCredentials is more extensible, allowing integration of additional authentication mechanisms such as biometrics and smart cards.</term></item><item><term>CredUIPromptForWindowsCredentials is compliant with the Common Criteria specification.</term></item></list></summary>
<param name="pUiInfo">A pointer to a CREDUI_INFO structure that contains information for customizing the appearance of the dialog box.</param>
<param name="pszTargetName">A pointer to a null-terminated string that contains the name of the target for the credentials, typically a server name. For Distributed File System (DFS) connections, this string is of the form ServerName\ShareName. This parameter is used to identify target information when storing and retrieving credentials.</param>
<param name="Reserved">This parameter is reserved for future use. It must be NULL.</param>
<param name="dwAuthError">Specifies why the credential dialog box is needed. A caller can pass this Windows error parameter, returned by another authentication call, to allow the dialog box to accommodate certain errors. For example, if the password expired status code is passed, the dialog box could prompt the user to change the password on the account.</param>
<param name="pszUserName">A pointer to a null-terminated string that contains the user name for the credentials. If a nonzero-length string is passed, the UserName option of the dialog box is prefilled with the string. In the case of credentials other than UserName/Password, a marshaled format of the credential can be passed in. This string is created by calling CredMarshalCredential.
<para>This function copies the user-supplied name to this buffer, copying a maximum of ulUserNameMaxChars characters. This format can be converted to UserName/Password format by using CredUIParseUsername. A marshaled format can be passed directly to a security support provider (SSP).</para><para>If the CREDUI_FLAGS_DO_NOT_PERSIST flag is not specified, the value returned in this parameter is of a form that should not be inspected, printed, or persisted other than passing it to CredUIParseUsername. The subsequent results of CredUIParseUsername can be passed only to a client-side authentication function such as WNetAddConnection or an SSP function.</para><para>If no domain or server is specified as part of this parameter, the value of the pszTargetName parameter is used as the domain to form a DomainName\UserName pair. On output, this parameter receives a string that contains that DomainName\UserName pair.</para></param>
<param name="ulUserNameMaxChars">The maximum number of characters that can be copied to pszUserName including the terminating null character.
<note>CREDUI_MAX_USERNAME_LENGTH does not include the terminating null character.</note></param>
<param name="pszPassword">A pointer to a null-terminated string that contains the password for the credentials. If a nonzero-length string is specified for pszPassword, the password option of the dialog box will be prefilled with the string.
<para>This function copies the user-supplied password to this buffer, copying a maximum of ulPasswordMaxChars characters. If the CREDUI_FLAGS_DO_NOT_PERSIST flag is not specified, the value returned in this parameter is of a form that should not be inspected, printed, or persisted other than passing it to a client-side authentication function such as WNetAddConnection or an SSP function.</para><para>When you have finished using the password, clear the password from memory by calling the SecureZeroMemory function. For more information about protecting passwords, see Handling Passwords.</para></param>
<param name="ulPasswordMaxChars">The maximum number of characters that can be copied to pszPassword including the terminating null character.
<note>CREDUI_MAX_USERNAME_LENGTH does not include the terminating null character.</note></param>
<param name="pfSave">A pointer to a BOOL that specifies the initial state of the Save check box and receives the state of the Save check box after the user has responded to the dialog box. If this value is not NULL and CredUIPromptForCredentials returns NO_ERROR, then pfSave returns the state of the Save check box when the user chose OK in the dialog box.
<para>If the CREDUI_FLAGS_PERSIST flag is specified, the Save check box is not displayed, but is considered to be selected.</para><para>If the CREDUI_FLAGS_DO_NOT_PERSIST flag is specified and CREDUI_FLAGS_SHOW_SAVE_CHECK_BOX is not specified, the Save check box is not displayed, but is considered to be cleared.</para><para>An application that needs to use CredUI to prompt the user for credentials, but does not need the credential management services provided by the credential manager, can use pfSave to receive the state of the Save check box after the user closes the dialog box. To do this, the caller must specify CREDUI_FLAGS_DO_NOT_PERSIST and CREDUI_FLAGS_SHOW_SAVE_CHECK_BOX in dwFlags. When CREDUI_FLAGS_DO_NOT_PERSIST and CREDUI_FLAGS_SHOW_SAVE_CHECK_BOX are set, the application is responsible for examining *pfSave after the function returns, and if *pfSave is TRUE, then the application must take the appropriate action to save the user credentials within the resources of the application.</para></param>
<param name="dwFlags">A DWORD value that specifies special behavior for this function. This value can be a bitwise-OR combination of any enumerated value.</param>
<returns>Status of the operation is returned.</returns>
</member>
<member name="M:Vanara.PInvoke.CredUI.CredUIPromptForWindowsCredentials(Vanara.PInvoke.CredUI.CREDUI_INFO@,System.Int32,System.UInt32@,System.IntPtr,System.UInt32,System.IntPtr@,System.UInt32@,System.Boolean@,Vanara.PInvoke.CredUI.WindowsCredentialsDialogOptions)">
<summary>
The CredUIPromptForWindowsCredentials function creates and displays a configurable dialog box that allows users to supply credential information by using any credential provider installed on the local computer.
</summary>
<param name="pUiInfo">A pointer to a CREDUI_INFO structure that contains information for customizing the appearance of the dialog box that this function displays.
<para>If the hwndParent member of the CREDUI_INFO structure is not NULL, this function displays a modal dialog box centered on the parent window.</para><para>If the hwndParent member of the CREDUI_INFO structure is NULL, the function displays a dialog box centered on the screen.</para><para>This function ignores the hbmBanner member of the CREDUI_INFO structure.</para></param>
<param name="dwAuthError">A Windows error code, defined in Winerror.h, that is displayed in the dialog box. If credentials previously collected were not valid, the caller uses this parameter to pass the error message from the API that collected the credentials (for example, Winlogon) to this function. The corresponding error message is formatted and displayed in the dialog box. Set the value of this parameter to zero to display no error message.</param>
<param name="pulAuthPackage">On input, the value of this parameter is used to specify the authentication package for which the credentials in the pvInAuthBuffer buffer are serialized. If the value of pvInAuthBuffer is NULL and the CREDUIWIN_AUTHPACKAGE_ONLY flag is set in the dwFlags parameter, only credential providers capable of serializing credentials for the specified authentication package are to be enumerated.
<para>To get the appropriate value to use for this parameter on input, call the LsaLookupAuthenticationPackage function and use the value of the AuthenticationPackage parameter of that function.</para><para>On output, this parameter specifies the authentication package for which the credentials in the ppvOutAuthBuffer buffer are serialized.</para></param>
<param name="pvInAuthBuffer">A pointer to a credential BLOB that is used to populate the credential fields in the dialog box. Set the value of this parameter to NULL to leave the credential fields empty.</param>
<param name="ulInAuthBufferSize">The size, in bytes, of the pvInAuthBuffer buffer.</param>
<param name="ppvOutAuthBuffer">The address of a pointer that, on output, specifies the credential BLOB. For Kerberos, NTLM, or Negotiate credentials, call the CredUnPackAuthenticationBuffer function to convert this BLOB to string representations of the credentials.
<para>When you have finished using the credential BLOB, clear it from memory by calling the SecureZeroMemory function, and free it by calling the CoTaskMemFree function.</para></param>
<param name="pulOutAuthBufferSize">The size, in bytes, of the ppvOutAuthBuffer buffer.</param>
<param name="pfSave">A pointer to a Boolean value that, on input, specifies whether the Save check box is selected in the dialog box that this function displays. On output, the value of this parameter specifies whether the Save check box was selected when the user clicks the Submit button in the dialog box. Set this parameter to NULL to ignore the Save check box.
<para>This parameter is ignored if the CREDUIWIN_CHECKBOX flag is not set in the dwFlags parameter.</para></param>
<param name="dwFlags">A DWORD value that specifies special behavior for this function. This value can be a bitwise-OR combination of any enumerated value.</param>
<returns>Status of the operation is returned.</returns>
</member>
<member name="M:Vanara.PInvoke.CredUI.CredUnPackAuthenticationBuffer(System.Int32,System.IntPtr,System.Int32,System.IntPtr,System.Int32@,System.IntPtr,System.Int32@,System.IntPtr,System.Int32@)">
<summary>
The CredUnPackAuthenticationBuffer function converts an authentication buffer returned by a call to the CredUIPromptForWindowsCredentials function into a string user name and password.
</summary>
<param name="dwFlags">Setting the value of this parameter to CRED_PACK_PROTECTED_CREDENTIALS specifies that the function attempts to decrypt the credentials in the authentication buffer. If the credential cannot be decrypted, the function returns FALSE, and a call to the GetLastError function will return the value ERROR_NOT_CAPABLE.
<para>How the decryption is done depends on the format of the authentication buffer.</para><para>If the authentication buffer is a SEC_WINNT_AUTH_IDENTITY_EX2 structure, the function can decrypt the buffer if it is encrypted by using SspiEncryptAuthIdentityEx with the SEC_WINNT_AUTH_IDENTITY_ENCRYPT_SAME_LOGON option.</para><para>If the authentication buffer is one of the marshaled KERB_*_LOGON structures, the function decrypts the password before returning it in the pszPassword buffer.</para></param>
<param name="pAuthBuffer">A pointer to the authentication buffer to be converted.
<para>This buffer is typically the output of the CredUIPromptForWindowsCredentials or CredPackAuthenticationBuffer function. This must be one of the following types:</para><list type="bullet"><item><term>A SEC_WINNT_AUTH_IDENTITY_EX2 structure for identity credentials. The function does not accept other SEC_WINNT_AUTH_IDENTITY structures.</term></item><item><term>A KERB_INTERACTIVE_LOGON or KERB_INTERACTIVE_UNLOCK_LOGON structure for password credentials.</term></item><item><term>A KERB_CERTIFICATE_LOGON or KERB_CERTIFICATE_UNLOCK_LOGON structure for smart card certificate credentials.</term></item><item><term>GENERIC_CRED for generic credentials.</term></item></list></param>
<param name="cbAuthBuffer">The size, in bytes, of the pAuthBuffer buffer.</param>
<param name="pszUserName">A pointer to a null-terminated string that receives the user name.
<para>This string can be a marshaled credential. See Remarks.</para></param>
<param name="pcchMaxUserName">A pointer to a DWORD value that specifies the size, in characters, of the pszUserName buffer. On output, if the buffer is not of sufficient size, specifies the required size, in characters, of the pszUserName buffer. The size includes terminating null character.</param>
<param name="pszDomainName">A pointer to a null-terminated string that receives the name of the user's domain.</param>
<param name="pcchMaxDomainame">A pointer to a DWORD value that specifies the size, in characters, of the pszDomainName buffer. On output, if the buffer is not of sufficient size, specifies the required size, in characters, of the pszDomainName buffer. The size includes the terminating null character. The required size can be zero if there is no domain name.</param>
<param name="pszPassword">A pointer to a null-terminated string that receives the password.</param>
<param name="pcchMaxPassword">A pointer to a DWORD value that specifies the size, in characters, of the pszPassword buffer. On output, if the buffer is not of sufficient size, specifies the required size, in characters, of the pszPassword buffer. The size includes the terminating null character.
<para>This string can be a marshaled credential. See Remarks.</para></param>
<returns>TRUE if the function succeeds; otherwise, FALSE. For extended error information, call the GetLastError function.The following table shows common values for the GetLastError function.</returns>
</member>
<member name="M:Vanara.PInvoke.CredUI.CredUnPackAuthenticationBuffer(System.Int32,System.IntPtr,System.Int32,System.Text.StringBuilder,System.Int32@,System.Text.StringBuilder,System.Int32@,System.Text.StringBuilder,System.Int32@)">
<summary>
The CredUnPackAuthenticationBuffer function converts an authentication buffer returned by a call to the CredUIPromptForWindowsCredentials function into a string user name and password.
</summary>
<param name="dwFlags">Setting the value of this parameter to CRED_PACK_PROTECTED_CREDENTIALS specifies that the function attempts to decrypt the credentials in the authentication buffer. If the credential cannot be decrypted, the function returns FALSE, and a call to the GetLastError function will return the value ERROR_NOT_CAPABLE.
<para>How the decryption is done depends on the format of the authentication buffer.</para><para>If the authentication buffer is a SEC_WINNT_AUTH_IDENTITY_EX2 structure, the function can decrypt the buffer if it is encrypted by using SspiEncryptAuthIdentityEx with the SEC_WINNT_AUTH_IDENTITY_ENCRYPT_SAME_LOGON option.</para><para>If the authentication buffer is one of the marshaled KERB_*_LOGON structures, the function decrypts the password before returning it in the pszPassword buffer.</para></param>
<param name="pAuthBuffer">A pointer to the authentication buffer to be converted.
<para>This buffer is typically the output of the CredUIPromptForWindowsCredentials or CredPackAuthenticationBuffer function. This must be one of the following types:</para><list type="bullet"><item><term>A SEC_WINNT_AUTH_IDENTITY_EX2 structure for identity credentials. The function does not accept other SEC_WINNT_AUTH_IDENTITY structures.</term></item><item><term>A KERB_INTERACTIVE_LOGON or KERB_INTERACTIVE_UNLOCK_LOGON structure for password credentials.</term></item><item><term>A KERB_CERTIFICATE_LOGON or KERB_CERTIFICATE_UNLOCK_LOGON structure for smart card certificate credentials.</term></item><item><term>GENERIC_CRED for generic credentials.</term></item></list></param>
<param name="cbAuthBuffer">The size, in bytes, of the pAuthBuffer buffer.</param>
<param name="pszUserName">A pointer to a null-terminated string that receives the user name.
<para>This string can be a marshaled credential. See Remarks.</para></param>
<param name="pcchMaxUserName">A pointer to a DWORD value that specifies the size, in characters, of the pszUserName buffer. On output, if the buffer is not of sufficient size, specifies the required size, in characters, of the pszUserName buffer. The size includes terminating null character.</param>
<param name="pszDomainName">A pointer to a null-terminated string that receives the name of the user's domain.</param>
<param name="pcchMaxDomainame">A pointer to a DWORD value that specifies the size, in characters, of the pszDomainName buffer. On output, if the buffer is not of sufficient size, specifies the required size, in characters, of the pszDomainName buffer. The size includes the terminating null character. The required size can be zero if there is no domain name.</param>
<param name="pszPassword">A pointer to a null-terminated string that receives the password.</param>
<param name="pcchMaxPassword">A pointer to a DWORD value that specifies the size, in characters, of the pszPassword buffer. On output, if the buffer is not of sufficient size, specifies the required size, in characters, of the pszPassword buffer. The size includes the terminating null character.
<para>This string can be a marshaled credential. See Remarks.</para></param>
<returns>TRUE if the function succeeds; otherwise, FALSE. For extended error information, call the GetLastError function.The following table shows common values for the GetLastError function.</returns>
</member>
<member name="T:Vanara.PInvoke.CredUI.CredentialsDialogOptions">
<summary>Options for the display of the <see cref="M:Vanara.PInvoke.CredUI.CredUIPromptForCredentials(Vanara.PInvoke.CredUI.CREDUI_INFO@,System.String,System.IntPtr,System.Int32,System.Text.StringBuilder,System.Int32,System.Text.StringBuilder,System.Int32,System.Boolean@,Vanara.PInvoke.CredUI.CredentialsDialogOptions)" /> and its functionality.</summary>
</member>
<member name="F:Vanara.PInvoke.CredUI.CredentialsDialogOptions.CREDUI_FLAGS_DEFAULT">
<summary>
Default flags settings These are the following values: <see cref="F:Vanara.PInvoke.CredUI.CredentialsDialogOptions.CREDUI_FLAGS_GENERIC_CREDENTIALS" />, <see cref="F:Vanara.PInvoke.CredUI.CredentialsDialogOptions.CREDUI_FLAGS_ALWAYS_SHOW_UI" />
and <see cref="F:Vanara.PInvoke.CredUI.CredentialsDialogOptions.CREDUI_FLAGS_EXPECT_CONFIRMATION" /></summary>
</member>
<member name="F:Vanara.PInvoke.CredUI.CredentialsDialogOptions.CREDUI_FLAGS_NONE">
<summary>No options are set.</summary>
</member>
<member name="F:Vanara.PInvoke.CredUI.CredentialsDialogOptions.CREDUI_FLAGS_INCORRECT_PASSWORD">
<summary>Notify the user of insufficient credentials by displaying the "Logon unsuccessful" balloon tip.</summary>
</member>
<member name="F:Vanara.PInvoke.CredUI.CredentialsDialogOptions.CREDUI_FLAGS_DO_NOT_PERSIST">
<summary>
Do not store credentials or display check boxes. You can pass ShowSaveCheckBox with this newDS to display the Save check box only, and the result
is returned in the CredentialsDialog.SaveChecked property.
</summary>
</member>
<member name="F:Vanara.PInvoke.CredUI.CredentialsDialogOptions.CREDUI_FLAGS_REQUEST_ADMINISTRATOR">
<summary>Populate the combo box with local administrators only.</summary>
</member>
<member name="F:Vanara.PInvoke.CredUI.CredentialsDialogOptions.CREDUI_FLAGS_EXCLUDE_CERTIFICATES">
<summary>Populate the combo box with user name/password only. Do not display certificates or smart cards in the combo box.</summary>
</member>
<member name="F:Vanara.PInvoke.CredUI.CredentialsDialogOptions.CREDUI_FLAGS_REQUIRE_CERTIFICATE">
<summary>Populate the combo box with certificates and smart cards only. Do not allow a user name to be entered.</summary>
</member>
<member name="F:Vanara.PInvoke.CredUI.CredentialsDialogOptions.CREDUI_FLAGS_SHOW_SAVE_CHECK_BOX">
<summary>
If the check box is selected, show the Save check box and return <c>true</c> in the CredentialsDialog.SaveChecked property, otherwise, return
<c>false</c>. Check box uses the value in the CredentialsDialog.SaveChecked property by default.
</summary>
</member>
<member name="F:Vanara.PInvoke.CredUI.CredentialsDialogOptions.CREDUI_FLAGS_ALWAYS_SHOW_UI">
<summary>
Specifies that a user interface will be shown even if the credentials can be returned from an existing credential in credential manager. This
newDS is permitted only if GenericCredentials is also specified.
</summary>
</member>
<member name="F:Vanara.PInvoke.CredUI.CredentialsDialogOptions.CREDUI_FLAGS_REQUIRE_SMARTCARD">
<summary>Populate the combo box with certificates or smart cards only. Do not allow a user name to be entered.</summary>
</member>
<member name="F:Vanara.PInvoke.CredUI.CredentialsDialogOptions.CREDUI_FLAGS_PASSWORD_ONLY_OK">
<summary></summary>
</member>
<member name="F:Vanara.PInvoke.CredUI.CredentialsDialogOptions.CREDUI_FLAGS_VALIDATE_USERNAME">
<summary></summary>
</member>
<member name="F:Vanara.PInvoke.CredUI.CredentialsDialogOptions.CREDUI_FLAGS_COMPLETE_USERNAME">
<summary></summary>
</member>
<member name="F:Vanara.PInvoke.CredUI.CredentialsDialogOptions.CREDUI_FLAGS_PERSIST">
<summary>Do not show the Save check box, but the credential is saved as though the box were shown and selected.</summary>
</member>
<member name="F:Vanara.PInvoke.CredUI.CredentialsDialogOptions.CREDUI_FLAGS_SERVER_CREDENTIAL">
<summary>
This newDS is meaningful only in locating a matching credential to pre-fill the dialog box, should authentication fail. When this newDS is
specified, wildcard credentials will not be matched. It has no effect when writing a credential. CredUI does not create credentials that contain
wildcard characters. Any found were either created explicitly by the user or created programmatically, as happens when a RAS connection is made.
</summary>
</member>
<member name="F:Vanara.PInvoke.CredUI.CredentialsDialogOptions.CREDUI_FLAGS_EXPECT_CONFIRMATION">
<summary>
Specifies that the caller will call ConfirmCredentials after checking to determine whether the returned credentials are actually valid. This
mechanism ensures that credentials that are not valid are not saved to the credential manager. Specify this newDS in all cases unless
DoNotPersist is specified.
</summary>
</member>
<member name="F:Vanara.PInvoke.CredUI.CredentialsDialogOptions.CREDUI_FLAGS_GENERIC_CREDENTIALS">
<summary>Consider the credentials entered by the user to be generic credentials, rather than windows credentials.</summary>
</member>
<member name="F:Vanara.PInvoke.CredUI.CredentialsDialogOptions.CREDUI_FLAGS_USERNAME_TARGET_CREDENTIALS">
<summary>
The credential is a "RunAs" credential. The TargetName parameter specifies the name of the command or program being run. It is used for prompting
purposes only.
</summary>
</member>
<member name="F:Vanara.PInvoke.CredUI.CredentialsDialogOptions.CREDUI_FLAGS_KEEP_USERNAME">
<summary>Do not allow the user to change the supplied user name.</summary>
</member>
<member name="T:Vanara.PInvoke.CredUI.CredPackFlags">
<summary>Specifies how the credential should be packed.</summary>
</member>
<member name="F:Vanara.PInvoke.CredUI.CredPackFlags.CRED_PACK_PROTECTED_CREDENTIALS">
<summary>Encrypts the credential so that it can only be decrypted by processes in the caller's logon session.</summary>
</member>
<member name="F:Vanara.PInvoke.CredUI.CredPackFlags.CRED_PACK_WOW_BUFFER">
<summary>Encrypts the credential in a WOW buffer.</summary>
</member>
<member name="F:Vanara.PInvoke.CredUI.CredPackFlags.CRED_PACK_GENERIC_CREDENTIALS">
<summary>Encrypts the credential in a CRED_GENERIC buffer.</summary>
</member>
<member name="F:Vanara.PInvoke.CredUI.CredPackFlags.CRED_PACK_ID_PROVIDER_CREDENTIALS">
<summary>
Encrypts the credential of an online identity into a SEC_WINNT_AUTH_IDENTITY_EX2 structure.If CRED_PACK_GENERIC_CREDENTIALS and
CRED_PACK_ID_PROVIDER_CREDENTIALS are not set, encrypts the credentials in a KERB_INTERACTIVE_LOGON buffer.
<para><c>Windows 7, Windows Server 2008 R2, Windows Vista, Windows Server 2008:</c> This value is not supported.</para></summary>
</member>
<member name="T:Vanara.PInvoke.CredUI.CREDUI_INFO">
<summary>
The CREDUI_INFO structure is used to pass information to the CredUIPromptForCredentials function that creates a dialog box used to obtain credentials information.
</summary>
</member>
<member name="M:Vanara.PInvoke.CredUI.CREDUI_INFO.#ctor(System.IntPtr,System.String,System.String)">
<summary>
Initializes a new instance of the <see cref="T:Vanara.PInvoke.CredUI.CREDUI_INFO" /> struct.
</summary>
<param name="hwndOwner">Specifies the handle to the parent window of the dialog box.</param>
<param name="caption">The string containing the title for the dialog box.</param>
<param name="message">The string containing a brief message to display in the dialog box.</param>
</member>
<member name="F:Vanara.PInvoke.CredUI.CREDUI_INFO.cbSize">
<summary>
Set to the size of the CREDUI_INFO structure.
</summary>
</member>
<member name="F:Vanara.PInvoke.CredUI.CREDUI_INFO.hbmBanner">
<summary>
Bitmap to display in the dialog box. If this member is NULL, a default bitmap is used. The bitmap size is limited to 320x60 pixels.
</summary>
</member>
<member name="F:Vanara.PInvoke.CredUI.CREDUI_INFO.hwndParent">
<summary>
Specifies the handle to the parent window of the dialog box. The dialog box is modal with respect to the parent window. If this member is NULL, the desktop is the parent window of the dialog box.
</summary>
</member>
<member name="F:Vanara.PInvoke.CredUI.CREDUI_INFO.pszCaptionText">
<summary>
Pointer to a string containing the title for the dialog box. The length of this string should not exceed CREDUI_MAX_CAPTION_LENGTH.
</summary>
</member>
<member name="F:Vanara.PInvoke.CredUI.CREDUI_INFO.pszMessageText">
<summary>
Pointer to a string containing a brief message to display in the dialog box. The length of this string should not exceed CREDUI_MAX_MESSAGE_LENGTH.
</summary>
</member>
<member name="T:Vanara.PInvoke.CredUI.WindowsCredentialsDialogOptions">
<summary>Options for the display of the <see cref="!:Vanara.PInvoke.CredUIPromptForWindowsCredentials" /> and its functionality.</summary>
</member>
<member name="F:Vanara.PInvoke.CredUI.WindowsCredentialsDialogOptions.CREDUIWIN_NONE">
<summary>No options are set.</summary>
</member>
<member name="F:Vanara.PInvoke.CredUI.WindowsCredentialsDialogOptions.CREDUIWIN_GENERIC">
<summary>
The caller is requesting that the credential provider return the user name and password in plain text. This value cannot be combined with SecurePrompt.
</summary>
</member>
<member name="F:Vanara.PInvoke.CredUI.WindowsCredentialsDialogOptions.CREDUIWIN_CHECKBOX">
<summary>The Save check box is displayed in the dialog box.</summary>
</member>
<member name="F:Vanara.PInvoke.CredUI.WindowsCredentialsDialogOptions.CREDUIWIN_AUTHPACKAGE_ONLY">
<summary>
Only credential providers that support the authentication package specified by the authPackage parameter should be enumerated. This value cannot
be combined with InAuthBufferCredentialsOnly.
</summary>
</member>
<member name="F:Vanara.PInvoke.CredUI.WindowsCredentialsDialogOptions.CREDUIWIN_IN_CRED_ONLY">
<summary>
Only the credentials specified by the InAuthBuffer parameter for the authentication package specified by the authPackage parameter should be
enumerated. If this flag is set, and the InAuthBuffer parameter is NULL, the function fails. This value cannot be combined with AuthPackageOnly.
</summary>
</member>
<member name="F:Vanara.PInvoke.CredUI.WindowsCredentialsDialogOptions.CREDUIWIN_ENUMERATE_ADMINS">
<summary>
Credential providers should enumerate only administrators. This value is intended for User Account Control (UAC) purposes only. We recommend that
external callers not set this flag.
</summary>
</member>
<member name="F:Vanara.PInvoke.CredUI.WindowsCredentialsDialogOptions.CREDUIWIN_ENUMERATE_CURRENT_USER">
<summary>Only the incoming credentials for the authentication package specified by the authPackage parameter should be enumerated.</summary>
</member>
<member name="F:Vanara.PInvoke.CredUI.WindowsCredentialsDialogOptions.CREDUIWIN_SECURE_PROMPT">
<summary>
The credential dialog box should be displayed on the secure desktop. This value cannot be combined with Generic. Windows Vista: This value is not
supported until Windows Vista with SP1.
</summary>
</member>
<member name="F:Vanara.PInvoke.CredUI.WindowsCredentialsDialogOptions.CREDUIWIN_PACK_32_WOW">
<summary>
The credential provider should align the credential BLOB pointed to by the refOutAuthBuffer parameter to a 32-bit boundary, even if the provider
is running on a 64-bit system.
</summary>
</member>
<member name="F:Vanara.PInvoke.CredUI.WindowsCredentialsDialogOptions.CREDUIWIN_PREPROMPTING">
<summary>
The credential dialog box is invoked by the SspiPromptForCredentials function, and the client is prompted before a prior handshake. If
SSPIPFC_NO_CHECKBOX is passed in the pvInAuthBuffer parameter, then the credential provider should not display the check box.
</summary>
</member>
</members>
</doc>

View File

@ -0,0 +1,326 @@
<?xml version="1.0" encoding="utf-8"?>
<doc>
<assembly>
<name>Vanara.PInvoke.DwmApi</name>
</assembly>
<members>
<member name="T:Vanara.PInvoke.DwmApi">
<summary>
<markup>
<include item="SMCMissingTag">
<parameter>summary</parameter>
<parameter>T:Vanara.PInvoke.DwmApi</parameter>
</include>
</markup>
</summary>
</member>
<member name="M:Vanara.PInvoke.DwmApi.DwmEnableBlurBehindWindow(System.IntPtr,Vanara.PInvoke.DwmApi.DWM_BLURBEHIND@)">
<summary>Enables the blur effect on a specified window.</summary>
<param name="hWnd">The handle to the window on which the blur behind data is applied.</param>
<param name="pDwmBlurbehind">A pointer to a DWM_BLURBEHIND structure that provides blur behind data.</param>
<returns>If this function succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.</returns>
</member>
<member name="M:Vanara.PInvoke.DwmApi.DwmEnableComposition(System.Int32)">
<summary>
Enables or disables Desktop Window Manager (DWM) composition. <note>This function is deprecated as of Windows 8. DWM can no longer be
programmatically disabled.</note></summary>
<param name="uCompositionAction">
DWM_EC_ENABLECOMPOSITION to enable DWM composition; DWM_EC_DISABLECOMPOSITION to disable composition. <note>As of Windows 8, calling this function
with DWM_EC_DISABLECOMPOSITION has no effect. However, the function will still return a success code.</note></param>
<returns>If this function succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.</returns>
</member>
<member name="M:Vanara.PInvoke.DwmApi.DwmExtendFrameIntoClientArea(System.IntPtr,Vanara.PInvoke.DwmApi.MARGINS@)">
<summary>Extends the window frame into the client area.</summary>
<param name="hWnd">The handle to the window in which the frame will be extended into the client area.</param>
<param name="pMarInset">A pointer to a MARGINS structure that describes the margins to use when extending the frame into the client area.</param>
<returns>If this function succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.</returns>
</member>
<member name="M:Vanara.PInvoke.DwmApi.DwmGetColorizationParameters(Vanara.PInvoke.DwmApi.DWM_COLORIZATION_PARAMS@)">
<summary>Gets the colorization parameters.</summary>
<param name="parameters">The parameters.</param>
<returns>If this function succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.</returns>
</member>
<member name="M:Vanara.PInvoke.DwmApi.DwmGetWindowAttribute(System.IntPtr,Vanara.PInvoke.DwmApi.DWMWINDOWATTRIBUTE,System.IntPtr,System.Int32)">
<summary>Retrieves the current value of a specified attribute applied to a window.</summary>
<param name="hwnd">The handle to the window from which the attribute data is retrieved.</param>
<param name="dwAttribute">The attribute to retrieve, specified as a DWMWINDOWATTRIBUTE value.</param>
<param name="pvAttribute">
A pointer to a value that, when this function returns successfully, receives the current value of the attribute. The type of the retrieved value
depends on the value of the dwAttribute parameter.
</param>
<param name="cbAttribute">The size of the DWMWINDOWATTRIBUTE value being retrieved. The size is dependent on the type of the pvAttribute parameter.</param>
<returns>If this function succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.</returns>
</member>
<member name="M:Vanara.PInvoke.DwmApi.DwmGetWindowAttribute``1(System.IntPtr,Vanara.PInvoke.DwmApi.DWMWINDOWATTRIBUTE,``0@)">
<summary>Retrieves the current value of a specified attribute applied to a window.</summary>
<param name="hwnd">The handle to the window from which the attribute data is retrieved.</param>
<param name="dwAttribute">The attribute to retrieve, specified as a DWMWINDOWATTRIBUTE value.</param>
<param name="pvAttribute">
A value that, when this function returns successfully, receives the current value of the attribute. The type of the retrieved value
depends on the value of the dwAttribute parameter.
</param>
<typeparam name="T">
<markup>
<include item="SMCMissingParamTag">
<parameter>typeparam</parameter>
<parameter>T</parameter>
<parameter>M:Vanara.PInvoke.DwmApi.DwmGetWindowAttribute``1(System.IntPtr,Vanara.PInvoke.DwmApi.DWMWINDOWATTRIBUTE,``0@)</parameter>
</include>
</markup>
</typeparam>
<returns>If this function succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.</returns>
</member>
<member name="M:Vanara.PInvoke.DwmApi.DwmIsCompositionEnabled(System.Boolean@)">
<summary>
Obtains a value that indicates whether Desktop Window Manager (DWM) composition is enabled. Applications on machines running Windows 7 or earlier can
listen for composition state changes by handling the WM_DWMCOMPOSITIONCHANGED notification.
</summary>
<param name="pfEnabled">
A pointer to a value that, when this function returns successfully, receives TRUE if DWM composition is enabled; otherwise, FALSE. <note>As of
Windows 8, DWM composition is always enabled. If an app declares Windows 8 compatibility in their manifest, this function will receive a value of
TRUE through pfEnabled. If no such manifest entry is found, Windows 8 compatibility is not assumed and this function receives a value of FALSE
through pfEnabled. This is done so that older programs that interpret a value of TRUE to imply that high contrast mode is off can continue to make
the correct decisions about rendering their images. (Note that this is a bad practice—you should use the SystemParametersInfo function with the
SPI_GETHIGHCONTRAST flag to determine the state of high contrast mode.)</note></param>
<returns>If this function succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.</returns>
</member>
<member name="M:Vanara.PInvoke.DwmApi.DwmSetColorizationParameters(Vanara.PInvoke.DwmApi.DWM_COLORIZATION_PARAMS@,System.UInt32)">
<summary>Sets the colorization parameters.</summary>
<param name="parameters">The parameters.</param>
<param name="unk">Always set to 1.</param>
<returns>If this function succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.</returns>
</member>
<member name="M:Vanara.PInvoke.DwmApi.DwmSetWindowAttribute(System.IntPtr,Vanara.PInvoke.DwmApi.DWMWINDOWATTRIBUTE,System.IntPtr,System.Int32)">
<summary>Sets the value of non-client rendering attributes for a window.</summary>
<param name="hwnd">The handle to the window that will receive the attributes.</param>
<param name="dwAttribute">A single DWMWINDOWATTRIBUTE flag to apply to the window. This parameter specifies the attribute and the pvAttribute parameter points to the value of that attribute.</param>
<param name="pvAttribute">A pointer to the value of the attribute specified in the dwAttribute parameter. Different DWMWINDOWATTRIBUTE flags require different value types.</param>
<param name="cbAttribute">The size, in bytes, of the value type pointed to by the pvAttribute parameter.</param>
<returns>If this function succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.</returns>
</member>
<member name="M:Vanara.PInvoke.DwmApi.DwmSetWindowAttribute``1(System.IntPtr,Vanara.PInvoke.DwmApi.DWMWINDOWATTRIBUTE,``0)">
<summary>Sets the value of non-client rendering attributes for a window.</summary>
<param name="hwnd">The handle to the window that will receive the attributes.</param>
<param name="dwAttribute">A single DWMWINDOWATTRIBUTE flag to apply to the window. This parameter specifies the attribute and the pvAttribute parameter points to the value of that attribute.</param>
<param name="pvAttribute">The value of the attribute specified in the dwAttribute parameter. Different DWMWINDOWATTRIBUTE flags require different value types.</param>
<typeparam name="T">
<markup>
<include item="SMCMissingParamTag">
<parameter>typeparam</parameter>
<parameter>T</parameter>
<parameter>M:Vanara.PInvoke.DwmApi.DwmSetWindowAttribute``1(System.IntPtr,Vanara.PInvoke.DwmApi.DWMWINDOWATTRIBUTE,``0)</parameter>
</include>
</markup>
</typeparam>
<returns>If this function succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.</returns>
</member>
<member name="T:Vanara.PInvoke.DwmApi.DWM_BLURBEHIND">
<summary>Specifies Desktop Window Manager (DWM) blur-behind properties. Used by the DwmEnableBlurBehindWindow function.</summary>
</member>
<member name="M:Vanara.PInvoke.DwmApi.DWM_BLURBEHIND.#ctor(System.Boolean)">
<summary>
Initializes a new instance of the <see cref="T:Vanara.PInvoke.DwmApi.DWM_BLURBEHIND" /> struct.
</summary>
<param name="enabled">if set to <c>true</c> enabled.</param>
</member>
<member name="F:Vanara.PInvoke.DwmApi.DWM_BLURBEHIND.dwFlags">
<summary>
A bitwise combination of DWM Blur Behind constant values that indicates which of the members of this structure have been set.
</summary>
</member>
<member name="F:Vanara.PInvoke.DwmApi.DWM_BLURBEHIND.fEnable">
<summary>
TRUE to register the window handle to DWM blur behind; FALSE to unregister the window handle from DWM blur behind.
</summary>
</member>
<member name="F:Vanara.PInvoke.DwmApi.DWM_BLURBEHIND.fTransitionOnMaximized">
<summary>
TRUE if the window's colorization should transition to match the maximized windows; otherwise, FALSE.
</summary>
</member>
<member name="F:Vanara.PInvoke.DwmApi.DWM_BLURBEHIND.hRgnBlur">
<summary>
The region within the client area where the blur behind will be applied. A NULL value will apply the blur behind the entire client area.
</summary>
</member>
<member name="P:Vanara.PInvoke.DwmApi.DWM_BLURBEHIND.Region">
<summary>
Gets the region.
</summary>
</member>
<member name="M:Vanara.PInvoke.DwmApi.DWM_BLURBEHIND.SetRegion(System.Drawing.Graphics,System.Drawing.Region)">
<summary>
Sets the region.
</summary>
<param name="graphics">The graphics.</param>
<param name="region">The region.</param>
</member>
<member name="P:Vanara.PInvoke.DwmApi.DWM_BLURBEHIND.TransitionOnMaximized">
<summary>
Gets or sets a value indicating whether the window's colorization should transition to match the maximized windows.
</summary>
</member>
<member name="T:Vanara.PInvoke.DwmApi.DWM_BLURBEHIND_Mask">
<summary>Flags used by the DWM_BLURBEHIND structure to indicate which of its members contain valid information.</summary>
</member>
<member name="F:Vanara.PInvoke.DwmApi.DWM_BLURBEHIND_Mask.DWM_BB_ENABLE">
<summary>A value for the fEnable member has been specified.</summary>
</member>
<member name="F:Vanara.PInvoke.DwmApi.DWM_BLURBEHIND_Mask.DWM_BB_BLURREGION">
<summary>A value for the hRgnBlur member has been specified.</summary>
</member>
<member name="F:Vanara.PInvoke.DwmApi.DWM_BLURBEHIND_Mask.DWM_BB_TRANSITIONONMAXIMIZED">
<summary>A value for the fTransitionOnMaximized member has been specified.</summary>
</member>
<member name="T:Vanara.PInvoke.DwmApi.DWM_COLORIZATION_PARAMS">
<summary>Structure to get colorization information using the <see cref="!:PVanara.PInvokeDwmGetColorizationParameters" /> function.</summary>
</member>
<member name="F:Vanara.PInvoke.DwmApi.DWM_COLORIZATION_PARAMS.clrAfterGlow">
<summary>The ARGB after glow color.</summary>
</member>
<member name="F:Vanara.PInvoke.DwmApi.DWM_COLORIZATION_PARAMS.clrAfterGlowBalance">
<summary>Determines how bright the glass is (0 removes all color from borders).</summary>
</member>
<member name="F:Vanara.PInvoke.DwmApi.DWM_COLORIZATION_PARAMS.clrBlurBalance">
<summary>Determines how bright the blur is.</summary>
</member>
<member name="F:Vanara.PInvoke.DwmApi.DWM_COLORIZATION_PARAMS.clrColor">
<summary>The ARGB accent color.</summary>
</member>
<member name="F:Vanara.PInvoke.DwmApi.DWM_COLORIZATION_PARAMS.clrGlassReflectionIntensity">
<summary>Determines how much the glass reflection is visible.</summary>
</member>
<member name="F:Vanara.PInvoke.DwmApi.DWM_COLORIZATION_PARAMS.fOpaque">
<summary>Determines if borders are opaque ( <c>true</c>) or transparent ( <c>false</c>).</summary>
</member>
<member name="F:Vanara.PInvoke.DwmApi.DWM_COLORIZATION_PARAMS.nIntensity">
<summary>Determines how much the glass streaks are visible in window borders.</summary>
</member>
<member name="T:Vanara.PInvoke.DwmApi.DWMWINDOWATTRIBUTE">
<summary>Flags used by the DwmGetWindowAttribute and DwmSetWindowAttribute functions to specify window attributes for non-client rendering.</summary>
</member>
<member name="F:Vanara.PInvoke.DwmApi.DWMWINDOWATTRIBUTE.DWMWA_NCRENDERING_ENABLED">
<summary>Use with DwmGetWindowAttribute. Discovers whether non-client rendering is enabled. The retrieved value is of type BOOL. TRUE if non-client rendering is enabled; otherwise, FALSE.</summary>
</member>
<member name="F:Vanara.PInvoke.DwmApi.DWMWINDOWATTRIBUTE.DWMWA_NCRENDERING_POLICY">
<summary>Use with DwmSetWindowAttribute. Sets the non-client rendering policy. The pvAttribute parameter points to a value from the DWMNCRENDERINGPOLICY enumeration.</summary>
</member>
<member name="F:Vanara.PInvoke.DwmApi.DWMWINDOWATTRIBUTE.DWMWA_TRANSITIONS_FORCEDISABLED">
<summary>Use with DwmSetWindowAttribute. Enables or forcibly disables DWM transitions. The pvAttribute parameter points to a value of TRUE to disable transitions or FALSE to enable transitions.</summary>
</member>
<member name="F:Vanara.PInvoke.DwmApi.DWMWINDOWATTRIBUTE.DWMWA_ALLOW_NCPAINT">
<summary>Use with DwmSetWindowAttribute. Enables content rendered in the non-client area to be visible on the frame drawn by DWM. The pvAttribute parameter points to a value of TRUE to enable content rendered in the non-client area to be visible on the frame; otherwise, it points to FALSE.</summary>
</member>
<member name="F:Vanara.PInvoke.DwmApi.DWMWINDOWATTRIBUTE.DWMWA_CAPTION_BUTTON_BOUNDS">
<summary>Use with DwmGetWindowAttribute. Retrieves the bounds of the caption button area in the window-relative space. The retrieved value is of type RECT.</summary>
</member>
<member name="F:Vanara.PInvoke.DwmApi.DWMWINDOWATTRIBUTE.DWMWA_NONCLIENT_RTL_LAYOUT">
<summary>Use with DwmSetWindowAttribute. Specifies whether non-client content is right-to-left (RTL) mirrored. The pvAttribute parameter points to a value of TRUE if the non-client content is right-to-left (RTL) mirrored; otherwise, it points to FALSE.</summary>
</member>
<member name="F:Vanara.PInvoke.DwmApi.DWMWINDOWATTRIBUTE.DWMWA_FORCE_ICONIC_REPRESENTATION">
<summary>Use with DwmSetWindowAttribute. Forces the window to display an iconic thumbnail or peek representation (a static bitmap), even if a live or snapshot representation of the window is available. This value normally is set during a window's creation and not changed throughout the window's lifetime. Some scenarios, however, might require the value to change over time. The pvAttribute parameter points to a value of TRUE to require a iconic thumbnail or peek representation; otherwise, it points to FALSE.</summary>
</member>
<member name="F:Vanara.PInvoke.DwmApi.DWMWINDOWATTRIBUTE.DWMWA_FLIP3D_POLICY">
<summary>Use with DwmSetWindowAttribute. Sets how Flip3D treats the window. The pvAttribute parameter points to a value from the DWMFLIP3DWINDOWPOLICY enumeration.</summary>
</member>
<member name="F:Vanara.PInvoke.DwmApi.DWMWINDOWATTRIBUTE.DWMWA_EXTENDED_FRAME_BOUNDS">
<summary>Use with DwmGetWindowAttribute. Retrieves the extended frame bounds rectangle in screen space. The retrieved value is of type RECT.</summary>
</member>
<member name="F:Vanara.PInvoke.DwmApi.DWMWINDOWATTRIBUTE.DWMWA_HAS_ICONIC_BITMAP">
<summary>Use with DwmSetWindowAttribute. The window will provide a bitmap for use by DWM as an iconic thumbnail or peek representation (a static bitmap) for the window. DWMWA_HAS_ICONIC_BITMAP can be specified with DWMWA_FORCE_ICONIC_REPRESENTATION. DWMWA_HAS_ICONIC_BITMAP normally is set during a window's creation and not changed throughout the window's lifetime. Some scenarios, however, might require the value to change over time. The pvAttribute parameter points to a value of TRUE to inform DWM that the window will provide an iconic thumbnail or peek representation; otherwise, it points to FALSE.
<para><c>Windows Vista and earlier:</c> This value is not supported.</para></summary>
</member>
<member name="F:Vanara.PInvoke.DwmApi.DWMWINDOWATTRIBUTE.DWMWA_DISALLOW_PEEK">
<summary>Use with DwmSetWindowAttribute. Do not show peek preview for the window. The peek view shows a full-sized preview of the window when the mouse hovers over the window's thumbnail in the taskbar. If this attribute is set, hovering the mouse pointer over the window's thumbnail dismisses peek (in case another window in the group has a peek preview showing). The pvAttribute parameter points to a value of TRUE to prevent peek functionality or FALSE to allow it.
<para><c>Windows Vista and earlier:</c> This value is not supported.</para></summary>
</member>
<member name="F:Vanara.PInvoke.DwmApi.DWMWINDOWATTRIBUTE.DWMWA_EXCLUDED_FROM_PEEK">
<summary>Use with DwmSetWindowAttribute. Prevents a window from fading to a glass sheet when peek is invoked. The pvAttribute parameter points to a value of TRUE to prevent the window from fading during another window's peek or FALSE for normal behavior.
<para><c>Windows Vista and earlier:</c> This value is not supported.</para></summary>
</member>
<member name="F:Vanara.PInvoke.DwmApi.DWMWINDOWATTRIBUTE.DWMWA_CLOAK">
<summary>Use with DwmGetWindowAttribute. Cloaks the window such that it is not visible to the user. The window is still composed by DWM.
<para><c>Using with DirectComposition:</c> Use the DWMWA_CLOAK flag to cloak the layered child window when animating a representation of the window's content via a DirectComposition visual which has been associated with the layered child window. For more details on this usage case, see How to How to animate the bitmap of a layered child window.</para><para><c>Windows 7 and earlier:</c> This value is not supported.</para></summary>
</member>
<member name="F:Vanara.PInvoke.DwmApi.DWMWINDOWATTRIBUTE.DWMWA_CLOAKED">
<summary>Use with DwmGetWindowAttribute. If the window is cloaked, provides one of the following values explaining why:
<list type="table"><listheader><term>Name (Value)</term><definition>Meaning</definition></listheader><item><term>DWM_CLOAKED_APP 0x0000001</term><definition>The window was cloaked by its owner application.</definition></item><item><term>DWM_CLOAKED_SHELL 0x0000002</term><definition>The window was cloaked by the Shell.</definition></item><item><term>DWM_CLOAKED_INHERITED 0x0000004</term><definition>The cloak value was inherited from its owner window.</definition></item></list><para><c>Windows 7 and earlier:</c> This value is not supported.</para></summary>
</member>
<member name="F:Vanara.PInvoke.DwmApi.DWMWINDOWATTRIBUTE.DWMWA_FREEZE_REPRESENTATION">
<summary>Use with DwmSetWindowAttribute. Freeze the window's thumbnail image with its current visuals. Do no further live updates on the thumbnail image to match the window's contents.
<para><c>Windows 7 and earlier:</c> This value is not supported.</para></summary>
</member>
<member name="T:Vanara.PInvoke.DwmApi.MARGINS">
<summary>Returned by the GetThemeMargins function to define the margins of windows that have visual styles applied.</summary>
</member>
<member name="M:Vanara.PInvoke.DwmApi.MARGINS.#ctor(System.Int32)">
<summary>Initializes a new instance of the <see cref="T:Vanara.PInvoke.DwmApi.MARGINS" /> struct.</summary>
<param name="allMargins">Value to assign to all margins.</param>
</member>
<member name="M:Vanara.PInvoke.DwmApi.MARGINS.#ctor(System.Int32,System.Int32,System.Int32,System.Int32)">
<summary>Initializes a new instance of the <see cref="T:Vanara.PInvoke.DwmApi.MARGINS" /> struct.</summary>
<param name="left">The left border value.</param>
<param name="right">The right border value.</param>
<param name="top">The top border value.</param>
<param name="bottom">The bottom border value.</param>
</member>
<member name="P:Vanara.PInvoke.DwmApi.MARGINS.Bottom">
<summary>Gets or sets the bottom border value.</summary>
</member>
<member name="F:Vanara.PInvoke.DwmApi.MARGINS.cxLeftWidth">
<summary>Width of the left border that retains its size.</summary>
</member>
<member name="F:Vanara.PInvoke.DwmApi.MARGINS.cxRightWidth">
<summary>Width of the right border that retains its size.</summary>
</member>
<member name="F:Vanara.PInvoke.DwmApi.MARGINS.cyBottomHeight">
<summary>Height of the bottom border that retains its size.</summary>
</member>
<member name="F:Vanara.PInvoke.DwmApi.MARGINS.cyTopHeight">
<summary>Height of the top border that retains its size.</summary>
</member>
<member name="F:Vanara.PInvoke.DwmApi.MARGINS.Empty">
<summary>Retrieves a <see cref="T:Vanara.PInvoke.DwmApi.MARGINS" /> instance with all values set to 0.</summary>
</member>
<member name="M:Vanara.PInvoke.DwmApi.MARGINS.Equals(System.Object)">
<summary>Determines whether the specified <see cref="T:System.Object" />, is equal to this instance.</summary>
<param name="obj">The <see cref="T:System.Object" /> to compare with this instance.</param>
<returns>
<c>true</c> if the specified <see cref="T:System.Object" /> is equal to this instance; otherwise, <c>false</c>.</returns>
</member>
<member name="M:Vanara.PInvoke.DwmApi.MARGINS.GetHashCode">
<summary>Returns a hash code for this instance.</summary>
<returns>A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.</returns>
</member>
<member name="F:Vanara.PInvoke.DwmApi.MARGINS.Infinite">
<summary>Retrieves a <see cref="T:Vanara.PInvoke.DwmApi.MARGINS" /> instance with all values set to -1.</summary>
</member>
<member name="P:Vanara.PInvoke.DwmApi.MARGINS.Left">
<summary>Gets or sets the left border value.</summary>
</member>
<member name="M:Vanara.PInvoke.DwmApi.MARGINS.op_Equality(Vanara.PInvoke.DwmApi.MARGINS,Vanara.PInvoke.DwmApi.MARGINS)">
<summary>Determines if two <see cref="T:Vanara.PInvoke.DwmApi.MARGINS" /> values are equal.</summary>
<param name="m1">The first margin.</param>
<param name="m2">The second margin.</param>
<returns>
<c>true</c> if the values are equal; <c>false</c> otherwise.</returns>
</member>
<member name="M:Vanara.PInvoke.DwmApi.MARGINS.op_Inequality(Vanara.PInvoke.DwmApi.MARGINS,Vanara.PInvoke.DwmApi.MARGINS)">
<summary>Determines if two <see cref="T:Vanara.PInvoke.DwmApi.MARGINS" /> values are not equal.</summary>
<param name="m1">The first margin.</param>
<param name="m2">The second margin.</param>
<returns>
<c>true</c> if the values are unequal; <c>false</c> otherwise.</returns>
</member>
<member name="P:Vanara.PInvoke.DwmApi.MARGINS.Right">
<summary>Gets or sets the right border value.</summary>
</member>
<member name="P:Vanara.PInvoke.DwmApi.MARGINS.Top">
<summary>Gets or sets the top border value.</summary>
</member>
<member name="M:Vanara.PInvoke.DwmApi.MARGINS.ToString">
<summary>Returns a <see cref="T:System.String" /> that represents this instance.</summary>
<returns>A <see cref="T:System.String" /> that represents this instance.</returns>
</member>
</members>
</doc>

View File

@ -0,0 +1,983 @@
<?xml version="1.0" encoding="utf-8"?>
<doc>
<assembly>
<name>Vanara.PInvoke.Gdi32</name>
</assembly>
<members>
<member name="T:Vanara.PInvoke.Gdi32">
<summary>
<markup>
<include item="SMCMissingTag">
<parameter>summary</parameter>
<parameter>T:Vanara.PInvoke.Gdi32</parameter>
</include>
</markup>
</summary>
</member>
<member name="M:Vanara.PInvoke.Gdi32.AlphaBlend(Vanara.PInvoke.Gdi32.SafeDCHandle,System.Int32,System.Int32,System.Int32,System.Int32,Vanara.PInvoke.Gdi32.SafeDCHandle,System.Int32,System.Int32,System.Int32,System.Int32,Vanara.PInvoke.Gdi32.BLENDFUNCTION)">
<summary>The AlphaBlend function displays bitmaps that have transparent or semitransparent pixels.</summary>
<param name="hdcDest">A handle to the destination device context.</param>
<param name="nXOriginDest">The x-coordinate, in logical units, of the upper-left corner of the destination rectangle.</param>
<param name="nYOriginDest">The y-coordinate, in logical units, of the upper-left corner of the destination rectangle.</param>
<param name="nWidthDest">The width, in logical units, of the destination rectangle.</param>
<param name="nHeightDest">The height, in logical units, of the destination rectangle.</param>
<param name="hdcSrc">A handle to the source device context.</param>
<param name="nXOriginSrc">The x-coordinate, in logical units, of the upper-left corner of the source rectangle.</param>
<param name="nYOriginSrc">The y-coordinate, in logical units, of the upper-left corner of the source rectangle.</param>
<param name="nWidthSrc">The width, in logical units, of the source rectangle.</param>
<param name="nHeightSrc">The height, in logical units, of the source rectangle.</param>
<param name="blendFunction">
The alpha-blending function for source and destination bitmaps, a global alpha value to be applied to the entire source bitmap, and format
information for the source bitmap. The source and destination blend functions are currently limited to AC_SRC_OVER.
</param>
<returns>If the function succeeds, the return value is TRUE. If the function fails, the return value is FALSE.</returns>
</member>
<member name="M:Vanara.PInvoke.Gdi32.BitBlt(Vanara.PInvoke.Gdi32.SafeDCHandle,System.Int32,System.Int32,System.Int32,System.Int32,Vanara.PInvoke.Gdi32.SafeDCHandle,System.Int32,System.Int32,Vanara.PInvoke.Gdi32.RasterOperationMode)">
<summary>
The BitBlt function performs a bit-block transfer of the color data corresponding to a rectangle of pixels from the specified source device context
into a destination device context.
</summary>
<param name="hdc">A handle to the destination device context.</param>
<param name="nXDest">The x-coordinate, in logical units, of the upper-left corner of the destination rectangle.</param>
<param name="nYDest">The y-coordinate, in logical units, of the upper-left corner of the destination rectangle.</param>
<param name="nWidth">The width, in logical units, of the destination rectangle.</param>
<param name="nHeight">The height, in logical units, of the destination rectangle.</param>
<param name="hdcSrc">A handle to the source device context.</param>
<param name="nXSrc">The x-coordinate, in logical units, of the upper-left corner of the source rectangle.</param>
<param name="nYSrc">The y-coordinate, in logical units, of the upper-left corner of the source rectangle.</param>
<param name="dwRop">
A raster-operation code. These codes define how the color data for the source rectangle is to be combined with the color data for the destination
rectangle to achieve the final color.
</param>
<returns>
If the function succeeds, the return value is nonzero.
<para>If the function fails, the return value is zero. To get extended error information, call GetLastError.</para></returns>
</member>
<member name="M:Vanara.PInvoke.Gdi32.CreateCompatibleDC(System.IntPtr)">
<summary>The CreateCompatibleDC function creates a memory device context (DC) compatible with the specified device.</summary>
<param name="hDC">
A handle to an existing DC. If this handle is NULL, the function creates a memory DC compatible with the application's current screen.
</param>
<returns>
If the function succeeds, the return value is the handle to a memory DC.
<para>If the function fails, the return value is NULL.</para></returns>
</member>
<member name="M:Vanara.PInvoke.Gdi32.CreateDIBSection(Vanara.PInvoke.Gdi32.SafeDCHandle,Vanara.PInvoke.Gdi32.BITMAPINFO@,Vanara.PInvoke.Gdi32.DIBColorMode,System.IntPtr@,System.IntPtr,System.Int32)">
<summary>
The CreateDIBSection function creates a DIB that applications can write to directly. The function gives you a pointer to the location of the bitmap
bit values. You can supply a handle to a file-mapping object that the function will use to create the bitmap, or you can let the system allocate the
memory for the bitmap.
</summary>
<param name="hdc">
A handle to a device context. If the value of iUsage is DIB_PAL_COLORS, the function uses this device context's logical palette to initialize the DIB colors.
</param>
<param name="pbmi">A pointer to a BITMAPINFO structure that specifies various attributes of the DIB, including the bitmap dimensions and colors.</param>
<param name="iUsage">
The type of data contained in the bmiColors array member of the BITMAPINFO structure pointed to by pbmi (either logical palette indexes or literal
RGB values).
</param>
<param name="ppvBits">A pointer to a variable that receives a pointer to the location of the DIB bit values.</param>
<param name="hSection">
A handle to a file-mapping object that the function will use to create the DIB. This parameter can be NULL.
<para>
If hSection is not NULL, it must be a handle to a file-mapping object created by calling the CreateFileMapping function with the PAGE_READWRITE or
PAGE_WRITECOPY flag. Read-only DIB sections are not supported. Handles created by other means will cause CreateDIBSection to fail.
</para><para>
If hSection is not NULL, the CreateDIBSection function locates the bitmap bit values at offset dwOffset in the file-mapping object referred to by
hSection. An application can later retrieve the hSection handle by calling the GetObject function with the HBITMAP returned by CreateDIBSection.
</para><para>
If hSection is NULL, the system allocates memory for the DIB. In this case, the CreateDIBSection function ignores the dwOffset parameter. An
application cannot later obtain a handle to this memory. The dshSection member of the DIBSECTION structure filled in by calling the GetObject
function will be NULL.
</para></param>
<param name="dwOffset">
The offset from the beginning of the file-mapping object referenced by hSection where storage for the bitmap bit values is to begin. This value is
ignored if hSection is NULL. The bitmap bit values are aligned on doubleword boundaries, so dwOffset must be a multiple of the size of a DWORD.
</param>
<returns>
If the function succeeds, the return value is a handle to the newly created DIB, and *ppvBits points to the bitmap bit values.
<para>If the function fails, the return value is NULL, and *ppvBits is NULL.</para></returns>
</member>
<member name="M:Vanara.PInvoke.Gdi32.DeleteDC(System.IntPtr)">
<summary>The DeleteDC function deletes the specified device context (DC).</summary>
<param name="hdc">A handle to the device context.</param>
<returns>If the function succeeds, the return value is nonzero. If the function fails, the return value is zero.</returns>
</member>
<member name="M:Vanara.PInvoke.Gdi32.DeleteObject(System.IntPtr)">
<summary>
The DeleteObject function deletes a logical pen, brush, font, bitmap, region, or palette, freeing all system resources associated with the object.
After the object is deleted, the specified handle is no longer valid.
</summary>
<param name="hObject">A handle to a logical pen, brush, font, bitmap, region, or palette.</param>
<returns>
If the function succeeds, the return value is nonzero. If the specified handle is not valid or is currently selected into a DC, the return value is zero.
</returns>
</member>
<member name="M:Vanara.PInvoke.Gdi32.GdiFlush">
<summary>The GdiFlush function flushes the calling thread's current batch.</summary>
<returns>
If all functions in the current batch succeed, the return value is nonzero.
<para>If not all functions in the current batch succeed, the return value is zero, indicating that at least one function returned an error.</para></returns>
</member>
<member name="M:Vanara.PInvoke.Gdi32.GetDIBits(Vanara.PInvoke.Gdi32.SafeDCHandle,System.IntPtr,System.Int32,System.Int32,System.Byte[]@,Vanara.PInvoke.Gdi32.BITMAPINFO@,Vanara.PInvoke.Gdi32.DIBColorMode)">
<summary>
The GetDIBits function retrieves the bits of the specified compatible bitmap and copies them into a buffer as a DIB using the specified format.
</summary>
<param name="hdc">A handle to the device context.</param>
<param name="hbmp">A handle to the bitmap. This must be a compatible bitmap (DDB).</param>
<param name="uStartScan">The first scan line to retrieve.</param>
<param name="cScanLines">The number of scan lines to retrieve.</param>
<param name="lpvBits">
A pointer to a buffer to receive the bitmap data. If this parameter is NULL, the function passes the dimensions and format of the bitmap to the
BITMAPINFO structure pointed to by the lpbi parameter.
</param>
<param name="lpbi">A pointer to a BITMAPINFO structure that specifies the desired format for the DIB data.</param>
<param name="uUsage">The format of the bmiColors member of the BITMAPINFO structure.</param>
<returns>
If the lpvBits parameter is non-NULL and the function succeeds, the return value is the number of scan lines copied from the bitmap.
<para>If the lpvBits parameter is NULL and GetDIBits successfully fills the BITMAPINFO structure, the return value is nonzero.</para><para>If the function fails, the return value is zero.</para></returns>
</member>
<member name="M:Vanara.PInvoke.Gdi32.GetDIBits(Vanara.PInvoke.Gdi32.SafeDCHandle,System.IntPtr,System.Int32,System.Int32,System.IntPtr,Vanara.PInvoke.Gdi32.BITMAPINFO@,Vanara.PInvoke.Gdi32.DIBColorMode)">
<summary>
The GetDIBits function retrieves the bits of the specified compatible bitmap and copies them into a buffer as a DIB using the specified format.
</summary>
<param name="hdc">A handle to the device context.</param>
<param name="hbmp">A handle to the bitmap. This must be a compatible bitmap (DDB).</param>
<param name="uStartScan">The first scan line to retrieve.</param>
<param name="cScanLines">The number of scan lines to retrieve.</param>
<param name="lpvBits">
A pointer to a buffer to receive the bitmap data. If this parameter is NULL, the function passes the dimensions and format of the bitmap to the
BITMAPINFO structure pointed to by the lpbi parameter.
</param>
<param name="lpbi">A pointer to a BITMAPINFO structure that specifies the desired format for the DIB data.</param>
<param name="uUsage">The format of the bmiColors member of the BITMAPINFO structure.</param>
<returns>
If the lpvBits parameter is non-NULL and the function succeeds, the return value is the number of scan lines copied from the bitmap.
<para>If the lpvBits parameter is NULL and GetDIBits successfully fills the BITMAPINFO structure, the return value is nonzero.</para><para>If the function fails, the return value is zero.</para></returns>
</member>
<member name="M:Vanara.PInvoke.Gdi32.GetObject``1(System.IntPtr)">
<summary>The GetObject function retrieves information for the specified graphics object.</summary>
<param name="hgdiobj">
A handle to the graphics object of interest. This can be a handle to one of the following: a logical bitmap, a brush, a font, a palette, a pen, or a
device independent bitmap created by calling the CreateDIBSection function.
</param>
<typeparam name="T">The output structure type.</typeparam>
<returns>The output structure holding the information for the graphics object.</returns>
</member>
<member name="M:Vanara.PInvoke.Gdi32.GetObject(System.IntPtr,System.Int32,System.IntPtr)">
<summary>The GetObject function retrieves information for the specified graphics object.</summary>
<param name="hgdiobj">
A handle to the graphics object of interest. This can be a handle to one of the following: a logical bitmap, a brush, a font, a palette, a pen, or a
device independent bitmap created by calling the CreateDIBSection function.
</param>
<param name="cbBuffer">The number of bytes of information to be written to the buffer.</param>
<param name="lpvObject">
A pointer to a buffer that receives the information about the specified graphics object. If the <paramref name="lpvObject" /> parameter is NULL, the
function return value is the number of bytes required to store the information it writes to the buffer for the specified graphics object.
</param>
<returns>
If the function succeeds, and <paramref name="lpvObject" /> is a valid pointer, the return value is the number of bytes stored into the buffer.
<para>
If the function succeeds, and <paramref name="lpvObject" /> is NULL, the return value is the number of bytes required to hold the information the
function would store into the buffer.
</para><para>If the function fails, the return value is zero.</para></returns>
</member>
<member name="F:Vanara.PInvoke.Gdi32.LF_FACESIZE">
<summary>
<markup>
<include item="SMCMissingTag">
<parameter>summary</parameter>
<parameter>F:Vanara.PInvoke.Gdi32.LF_FACESIZE</parameter>
</include>
</markup>
</summary>
</member>
<member name="M:Vanara.PInvoke.Gdi32.SelectObject(Vanara.PInvoke.Gdi32.SafeDCHandle,System.IntPtr)">
<summary>
The SelectObject function selects an object into the specified device context (DC). The new object replaces the previous object of the same type.
</summary>
<param name="hDC">A handle to the DC.</param>
<param name="hObject">A handle to the object to be selected. The specified object must have been created by using one of the following functions.</param>
<returns>
If the selected object is not a region and the function succeeds, the return value is a handle to the object being replaced. If the selected object
is a region and the function succeeds, the return value is one of the following values.
</returns>
</member>
<member name="M:Vanara.PInvoke.Gdi32.SetBkMode(Vanara.PInvoke.Gdi32.SafeDCHandle,Vanara.PInvoke.Gdi32.BackgroundMode)">
<summary>
The SetBkMode function sets the background mix mode of the specified device context. The background mix mode is used with text, hatched brushes, and
pen styles that are not solid lines.
</summary>
<param name="hdc">A handle to the device context.</param>
<param name="mode">The background mode.</param>
<returns>If the function succeeds, the return value specifies the previous background mode. If the function fails, the return value is zero.</returns>
</member>
<member name="M:Vanara.PInvoke.Gdi32.SetLayout(Vanara.PInvoke.Gdi32.SafeDCHandle,Vanara.PInvoke.Gdi32.DCLayout)">
<summary>The SetLayout function changes the layout of a device context (DC).</summary>
<param name="hdc">A handle to the DC.</param>
<param name="dwLayout">The DC layout.</param>
<returns>If the function succeeds, it returns the previous layout of the DC. If the function fails, it returns GDI_ERROR.</returns>
</member>
<member name="M:Vanara.PInvoke.Gdi32.TransparentBlt(Vanara.PInvoke.Gdi32.SafeDCHandle,System.Int32,System.Int32,System.Int32,System.Int32,Vanara.PInvoke.Gdi32.SafeDCHandle,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
<summary>
The TransparentBlt function performs a bit-block transfer of the color data corresponding to a rectangle of pixels from the specified source device
context into a destination device context.
</summary>
<param name="hdcDest">A handle to the destination device context.</param>
<param name="xOriginDest">The x-coordinate, in logical units, of the upper-left corner of the destination rectangle.</param>
<param name="yOriginDest">The y-coordinate, in logical units, of the upper-left corner of the destination rectangle.</param>
<param name="wDest">The width, in logical units, of the destination rectangle.</param>
<param name="hDest">The height, in logical units, of the destination rectangle.</param>
<param name="hdcSrc">A handle to the source device context.</param>
<param name="xOriginSrc">The x-coordinate, in logical units, of the upper-left corner of the source rectangle.</param>
<param name="yOriginSrc">The y-coordinate, in logical units, of the upper-left corner of the source rectangle.</param>
<param name="wSrc">The width, in logical units, of the source rectangle.</param>
<param name="hSrc">The height, in logical units, of the source rectangle.</param>
<param name="crTransparent">The RGB color in the source bitmap to treat as transparent.</param>
<returns>If the function succeeds, the return value is TRUE. If the function fails, the return value is FALSE.</returns>
</member>
<member name="T:Vanara.PInvoke.Gdi32.BackgroundMode">
<summary>The background mode used by the <see cref="M:Vanara.PInvoke.Gdi32.SetBkMode(Vanara.PInvoke.Gdi32.SafeDCHandle,Vanara.PInvoke.Gdi32.BackgroundMode)" /> function.</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.BackgroundMode.ERROR">
<summary>Indicates that on return, the <see cref="M:Vanara.PInvoke.Gdi32.SetBkMode(Vanara.PInvoke.Gdi32.SafeDCHandle,Vanara.PInvoke.Gdi32.BackgroundMode)" /> has failed.</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.BackgroundMode.TRANSPARENT">
<summary>Background remains untouched.</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.BackgroundMode.OPAQUE">
<summary>Background is filled with the current background color before the text, hatched brush, or pen is drawn.</summary>
</member>
<member name="T:Vanara.PInvoke.Gdi32.BitmapCompressionMode">
<summary>The type of compression for a compressed bottom-up bitmap (top-down DIBs cannot be compressed). Used in <see cref="T:Vanara.PInvoke.Gdi32.BITMAPINFOHEADER" />.</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.BitmapCompressionMode.BI_RGB">
<summary>An uncompressed format.</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.BitmapCompressionMode.BI_RLE8">
<summary>
A run-length encoded (RLE) format for bitmaps with 8 bpp. The compression format is a 2-byte format consisting of a count byte followed by a byte
containing a color index.
</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.BitmapCompressionMode.BI_RLE4">
<summary>
An RLE format for bitmaps with 4 bpp. The compression format is a 2-byte format consisting of a count byte followed by two word-length color indexes.
</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.BitmapCompressionMode.BI_BITFIELDS">
<summary>
Specifies that the bitmap is not compressed and that the color table consists of three DWORD color masks that specify the red, green, and blue
components, respectively, of each pixel. This is valid when used with 16- and 32-bpp bitmaps.
</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.BitmapCompressionMode.BI_JPEG">
<summary>Indicates that the image is a JPEG image.</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.BitmapCompressionMode.BI_PNG">
<summary>Indicates that the image is a PNG image.</summary>
</member>
<member name="T:Vanara.PInvoke.Gdi32.BITMAPINFO">
<summary>The BITMAPINFO structure defines the dimensions and color information for a DIB.</summary>
</member>
<member name="M:Vanara.PInvoke.Gdi32.BITMAPINFO.#ctor(System.Int32,System.Int32,System.UInt16)">
<summary>Initializes a new instance of the <see cref="T:Vanara.PInvoke.Gdi32.BITMAPINFO" /> structure.</summary>
<param name="width">The width.</param>
<param name="height">The height.</param>
<param name="bitCount">The bit count.</param>
</member>
<member name="F:Vanara.PInvoke.Gdi32.BITMAPINFO.bmiColors">
<summary>
The bmiColors member contains one of the following:
<list type="bullet"><item><description>An array of RGBQUAD. The elements of the array that make up the color table.</description></item><item><description>
An array of 16-bit unsigned integers that specifies indexes into the currently realized logical palette. This use of bmiColors is allowed for
functions that use DIBs. When bmiColors elements contain indexes to a realized logical palette, they must also call the following bitmap
functions: CreateDIBitmap, CreateDIBPatternBrush, CreateDIBSection (The iUsage parameter of CreateDIBSection must be set to DIB_PAL_COLORS.)
</description></item></list><para>The number of entries in the array depends on the values of the biBitCount and biClrUsed members of the BITMAPINFOHEADER structure.</para><para>The colors in the bmiColors table appear in order of importance. For more information, see the Remarks section.</para></summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.BITMAPINFO.bmiHeader">
<summary>A BITMAPINFOHEADER structure that contains information about the dimensions of color format.</summary>
</member>
<member name="T:Vanara.PInvoke.Gdi32.BITMAPINFOHEADER">
<summary>The BITMAPINFOHEADER structure contains information about the dimensions and color format of a DIB.</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.BITMAPINFOHEADER.biBitCount">
<summary>
The number of bits-per-pixel. The biBitCount member of the BITMAPINFOHEADER structure determines the number of bits that define each pixel and
the maximum number of colors in the bitmap. This member must be one of the following values.
<list type="table"><listheader><term>Value</term><description>Meaning</description></listheader><item><term>0</term><description>The number of bits-per-pixel is specified or is implied by the JPEG or PNG format.</description></item><item><term>1</term><description>
The bitmap is monochrome, and the bmiColors member of BITMAPINFO contains two entries. Each bit in the bitmap array represents a pixel. If the
bit is clear, the pixel is displayed with the color of the first entry in the bmiColors table; if the bit is set, the pixel has the color of the
second entry in the table.
</description></item><item><term>4</term><description>
The bitmap has a maximum of 16 colors, and the bmiColors member of BITMAPINFO contains up to 16 entries. Each pixel in the bitmap is represented
by a 4-bit index into the color table. For example, if the first byte in the bitmap is 0x1F, the byte represents two pixels. The first pixel
contains the color in the second table entry, and the second pixel contains the color in the sixteenth table entry.
</description></item><item><term>8</term><description>
The bitmap has a maximum of 256 colors, and the bmiColors member of BITMAPINFO contains up to 256 entries. In this case, each byte in the array
represents a single pixel.
</description></item><item><term>16</term><description>
The bitmap has a maximum of 2^16 colors. If the biCompression member of the BITMAPINFOHEADER is BI_RGB, the bmiColors member of BITMAPINFO is
NULL. Each WORD in the bitmap array represents a single pixel. The relative intensities of red, green, and blue are represented with five bits
for each color component. The value for blue is in the least significant five bits, followed by five bits each for green and red. The most
significant bit is not used. The bmiColors color table is used for optimizing colors used on palette-based devices, and must contain the number
of entries specified by the biClrUsed member of the BITMAPINFOHEADER.
<para>
If the biCompression member of the BITMAPINFOHEADER is BI_BITFIELDS, the bmiColors member contains three DWORD color masks that specify the red,
green, and blue components, respectively, of each pixel. Each WORD in the bitmap array represents a single pixel.
</para><para>
When the biCompression member is BI_BITFIELDS, bits set in each DWORD mask must be contiguous and should not overlap the bits of another mask.
All the bits in the pixel do not have to be used.
</para></description></item><item><term>24</term><description>
The bitmap has a maximum of 2^24 colors, and the bmiColors member of BITMAPINFO is NULL. Each 3-byte triplet in the bitmap array represents the
relative intensities of blue, green, and red, respectively, for a pixel. The bmiColors color table is used for optimizing colors used on
palette-based devices, and must contain the number of entries specified by the biClrUsed member of the BITMAPINFOHEADER.
</description></item><item><term>32</term><description>
The bitmap has a maximum of 2^32 colors. If the biCompression member of the BITMAPINFOHEADER is BI_RGB, the bmiColors member of BITMAPINFO is
NULL. Each DWORD in the bitmap array represents the relative intensities of blue, green, and red for a pixel. The value for blue is in the least
significant 8 bits, followed by 8 bits each for green and red. The high byte in each DWORD is not used. The bmiColors color table is used for
optimizing colors used on palette-based devices, and must contain the number of entries specified by the biClrUsed member of the BITMAPINFOHEADER.
<para>
If the biCompression member of the BITMAPINFOHEADER is BI_BITFIELDS, the bmiColors member contains three DWORD color masks that specify the red,
green, and blue components, respectively, of each pixel. Each DWORD in the bitmap array represents a single pixel.
</para><para>
When the biCompression member is BI_BITFIELDS, bits set in each DWORD mask must be contiguous and should not overlap the bits of another mask.
All the bits in the pixel do not need to be used.
</para></description></item></list></summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.BITMAPINFOHEADER.biClrImportant">
<summary>The number of color indexes that are required for displaying the bitmap. If this value is zero, all colors are required.</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.BITMAPINFOHEADER.biClrUsed">
<summary>
The number of color indexes in the color table that are actually used by the bitmap. If this value is zero, the bitmap uses the maximum number of
colors corresponding to the value of the biBitCount member for the compression mode specified by biCompression.
<para>
If biClrUsed is nonzero and the biBitCount member is less than 16, the biClrUsed member specifies the actual number of colors the graphics engine
or device driver accesses. If biBitCount is 16 or greater, the biClrUsed member specifies the size of the color table used to optimize
performance of the system color palettes. If biBitCount equals 16 or 32, the optimal color palette starts immediately following the three DWORD masks.
</para><para>
When the bitmap array immediately follows the BITMAPINFO structure, it is a packed bitmap. Packed bitmaps are referenced by a single pointer.
Packed bitmaps require that the biClrUsed member must be either zero or the actual size of the color table.
</para></summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.BITMAPINFOHEADER.biCompression">
<summary>The type of compression for a compressed bottom-up bitmap (top-down DIBs cannot be compressed).</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.BITMAPINFOHEADER.biHeight">
<summary>
The height of the bitmap, in pixels. If biHeight is positive, the bitmap is a bottom-up DIB and its origin is the lower-left corner. If biHeight
is negative, the bitmap is a top-down DIB and its origin is the upper-left corner.
<para>If biHeight is negative, indicating a top-down DIB, biCompression must be either BI_RGB or BI_BITFIELDS. Top-down DIBs cannot be compressed.</para><para>If biCompression is BI_JPEG or BI_PNG, the biHeight member specifies the height of the decompressed JPEG or PNG image file, respectively.</para></summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.BITMAPINFOHEADER.biPlanes">
<summary>The number of planes for the target device. This value must be set to 1.</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.BITMAPINFOHEADER.biSize">
<summary>The number of bytes required by the structure.</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.BITMAPINFOHEADER.biSizeImage">
<summary>
The size, in bytes, of the image. This may be set to zero for BI_RGB bitmaps. If biCompression is BI_JPEG or BI_PNG, biSizeImage indicates the
size of the JPEG or PNG image buffer, respectively.
</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.BITMAPINFOHEADER.biWidth">
<summary>
The width of the bitmap, in pixels. If biCompression is BI_JPEG or BI_PNG, the biWidth member specifies the width of the decompressed JPEG or PNG
image file, respectively.
</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.BITMAPINFOHEADER.biXPelsPerMeter">
<summary>
The horizontal resolution, in pixels-per-meter, of the target device for the bitmap. An application can use this value to select a bitmap from a
resource group that best matches the characteristics of the current device.
</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.BITMAPINFOHEADER.biYPelsPerMeter">
<summary>The vertical resolution, in pixels-per-meter, of the target device for the bitmap.</summary>
</member>
<member name="T:Vanara.PInvoke.Gdi32.BLENDFUNCTION">
<summary>
The BLENDFUNCTION structure controls blending by specifying the blending functions for source and destination bitmaps.
</summary>
</member>
<member name="M:Vanara.PInvoke.Gdi32.BLENDFUNCTION.#ctor(System.Byte)">
<summary>Initializes a new instance of the <see cref="T:Vanara.PInvoke.Gdi32.BLENDFUNCTION" /> struct and sets the alpha value.</summary>
<param name="alpha">The alpha.</param>
</member>
<member name="F:Vanara.PInvoke.Gdi32.BLENDFUNCTION.AlphaFormat">
<summary>
This member controls the way the source and destination bitmaps are interpreted. AlphaFormat has the following value.
<para><c>AC_SRC_ALPHA</c> This flag is set when the bitmap has an Alpha channel (that is, per-pixel alpha). Note that the APIs use premultiplied alpha,
which means that the red, green and blue channel values in the bitmap must be premultiplied with the alpha channel value. For example, if the
alpha channel value is x, the red, green and blue channels must be multiplied by x and divided by 0xff prior to the call.
</para></summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.BLENDFUNCTION.BlendFlags">
<summary>Must be zero.</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.BLENDFUNCTION.BlendOp">
<summary>
The source blend operation. Currently, the only source and destination blend operation that has been defined is AC_SRC_OVER. For details, see the
following Remarks section.
</summary>
</member>
<member name="P:Vanara.PInvoke.Gdi32.BLENDFUNCTION.IsEmpty">
<summary>
<markup>
<include item="SMCMissingTag">
<parameter>summary</parameter>
<parameter>P:Vanara.PInvoke.Gdi32.BLENDFUNCTION.IsEmpty</parameter>
</include>
</markup>
</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.BLENDFUNCTION.SourceConstantAlpha">
<summary>
Specifies an alpha transparency value to be used on the entire source bitmap. The SourceConstantAlpha value is combined with any per-pixel alpha
values in the source bitmap. If you set SourceConstantAlpha to 0, it is assumed that your image is transparent. Set the SourceConstantAlpha value
to 255 (opaque) when you only want to use per-pixel alpha values.
</summary>
</member>
<member name="T:Vanara.PInvoke.Gdi32.DCLayout">
<summary>The DC layout used by the <see cref="M:Vanara.PInvoke.Gdi32.SetLayout(Vanara.PInvoke.Gdi32.SafeDCHandle,Vanara.PInvoke.Gdi32.DCLayout)" /> function.</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.DCLayout.GDI_ERROR">
<summary>Indicates that on return, the <see cref="M:Vanara.PInvoke.Gdi32.SetLayout(Vanara.PInvoke.Gdi32.SafeDCHandle,Vanara.PInvoke.Gdi32.DCLayout)" /> has failed.</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.DCLayout.LAYOUT_RTL">
<summary>Sets the default horizontal layout to be right to left.</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.DCLayout.LAYOUT_BTT">
<summary>Sets the default horizontal layout to be bottom to top.</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.DCLayout.LAYOUT_VBH">
<summary>Sets the default horizontal layout to be vertical before horizontal.</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.DCLayout.LAYOUT_BITMAPORIENTATIONPRESERVED">
<summary>Disables any reflection during BitBlt and StretchBlt operations.</summary>
</member>
<member name="T:Vanara.PInvoke.Gdi32.DIBColorMode">
<summary>
<markup>
<include item="SMCMissingTag">
<parameter>summary</parameter>
<parameter>T:Vanara.PInvoke.Gdi32.DIBColorMode</parameter>
</include>
</markup>
</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.DIBColorMode.DIB_RGB_COLORS">
<summary>The BITMAPINFO structure contains an array of literal RGB values.</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.DIBColorMode.DIB_PAL_COLORS">
<summary>
The bmiColors member of the BITMAPINFO structure is an array of 16-bit indexes into the logical palette of the device context specified by hdc.
</summary>
</member>
<member name="T:Vanara.PInvoke.Gdi32.LOGFONT">
<summary>The LOGFONT structure defines the attributes of a font.</summary>
</member>
<member name="P:Vanara.PInvoke.Gdi32.LOGFONT.FontFamily">
<summary>Gets or sets the font family.</summary>
</member>
<member name="M:Vanara.PInvoke.Gdi32.LOGFONT.FromFont(System.Drawing.Font)">
<summary>Gets a <see cref="T:Vanara.PInvoke.Gdi32.LOGFONT" /> structure from a <see cref="T:System.Drawing.Font" />.</summary>
<param name="font">The font.</param>
<returns>A <see cref="T:Vanara.PInvoke.Gdi32.LOGFONT" /> structure.</returns>
</member>
<member name="F:Vanara.PInvoke.Gdi32.LOGFONT.lfCharSet">
<summary>The character set.</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.LOGFONT.lfClipPrecision">
<summary>The clipping precision. The clipping precision defines how to clip characters that are partially outside the clipping region.</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.LOGFONT.lfEscapement">
<summary>
The angle, in tenths of degrees, between the escapement vector and the x-axis of the device. The escapement vector is parallel to the base line
of a row of text.
<para>
When the graphics mode is set to GM_ADVANCED, you can specify the escapement angle of the string independently of the orientation angle of the
string's characters.
</para><para>
When the graphics mode is set to GM_COMPATIBLE, lfEscapement specifies both the escapement and orientation. You should set lfEscapement and
lfOrientation to the same value.
</para></summary>
</member>
<member name="P:Vanara.PInvoke.Gdi32.LOGFONT.lfFaceName">
<summary>
A string that specifies the typeface name of the font. The length of this string must not exceed 31 characters. The EnumFontFamiliesEx function
can be used to enumerate the typeface names of all currently available fonts. If lfFaceName is an empty string, GDI uses the first font that
matches the other specified attributes.
</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.LOGFONT.lfHeight">
<summary>
The height, in logical units, of the font's character cell or character. The character height value (also known as the em height) is the
character cell height value minus the internal-leading value. The font mapper interprets the value specified in lfHeight in the following manner.
<list type="table"><listheader><term>Value</term><definition>Meaning</definition></listheader><item><term>&gt; 0</term><definition>The font mapper transforms this value into device units and matches it against the cell height of the available fonts.</definition></item><item><term>0</term><definition>The font mapper uses a default height value when it searches for a match.</definition></item><item><term>&lt; 0</term><definition>The font mapper transforms this value into device units and matches its absolute value against the character height of the available fonts.</definition></item></list><para>For all height comparisons, the font mapper looks for the largest font that does not exceed the requested size.</para><para>This mapping occurs when the font is used for the first time.</para><para>For the MM_TEXT mapping mode, you can use the following formula to specify a height for a font with a specified point size:</para></summary>
</member>
<member name="P:Vanara.PInvoke.Gdi32.LOGFONT.lfItalic">
<summary>Gets or sets a value indicating whether this <see cref="T:Vanara.PInvoke.Gdi32.LOGFONT" /> is italicized.</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.LOGFONT.lfOrientation">
<summary>The angle, in tenths of degrees, between each character's base line and the x-axis of the device.</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.LOGFONT.lfOutPrecision">
<summary>
The output precision. The output precision defines how closely the output must match the requested font's height, width, character orientation,
escapement, pitch, and font type.
</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.LOGFONT.lfQuality">
<summary>
The output quality. The output quality defines how carefully the graphics device interface (GDI) must attempt to match the logical-font
attributes to those of an actual physical font.
</summary>
</member>
<member name="P:Vanara.PInvoke.Gdi32.LOGFONT.lfStrikeOut">
<summary>Gets or sets a value indicating whether struck out.</summary>
</member>
<member name="P:Vanara.PInvoke.Gdi32.LOGFONT.lfUnderline">
<summary>Gets or sets a value indicating whether this <see cref="T:Vanara.PInvoke.Gdi32.LOGFONT" /> is underlined.</summary>
</member>
<member name="P:Vanara.PInvoke.Gdi32.LOGFONT.lfWeight">
<summary>
The weight of the font in the range 0 through 1000. For example, 400 is normal and 700 is bold. If this value is zero, a default weight is used.
</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.LOGFONT.lfWidth">
<summary>
The average width, in logical units, of characters in the font. If lfWidth is zero, the aspect ratio of the device is matched against the
digitization aspect ratio of the available fonts to find the closest match, determined by the absolute value of the difference.
</summary>
</member>
<member name="P:Vanara.PInvoke.Gdi32.LOGFONT.Pitch">
<summary>Gets or sets the font pitch.</summary>
</member>
<member name="M:Vanara.PInvoke.Gdi32.LOGFONT.ToFont">
<summary>Converts this structure to a <see cref="T:System.Drawing.Font" />.</summary>
<returns>A <see cref="T:System.Drawing.Font" /> matching the values of this structure.</returns>
</member>
<member name="M:Vanara.PInvoke.Gdi32.LOGFONT.ToString">
<summary>Returns a <see cref="T:System.String" /> that represents this instance.</summary>
<returns>A <see cref="T:System.String" /> that represents this instance.</returns>
</member>
<member name="T:Vanara.PInvoke.Gdi32.LogFontCharSet">
<summary>The character set.</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.LogFontCharSet.ANSI_CHARSET">
<summary>Specifies the English character set.</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.LogFontCharSet.DEFAULT_CHARSET">
<summary>
Specifies a character set based on the current system locale; for example, when the system locale is United States English, the default character
set is ANSI_CHARSET.
</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.LogFontCharSet.SYMBOL_CHARSET">
<summary>Specifies a character set of symbols.</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.LogFontCharSet.SHIFTJIS_CHARSET">
<summary>Specifies the Japanese character set.</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.LogFontCharSet.HANGEUL_CHARSET">
<summary>Specifies the Hangul Korean character set.</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.LogFontCharSet.HANGUL_CHARSET">
<summary>Also spelled "Hangeul". Specifies the Hangul Korean character set.</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.LogFontCharSet.GB2312_CHARSET">
<summary>Specifies the "simplified" Chinese character set for People's Republic of China.</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.LogFontCharSet.CHINESEBIG5_CHARSET">
<summary>Specifies the "traditional" Chinese character set, used mostly in Taiwan and in the Hong Kong and Macao Special Administrative Regions.</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.LogFontCharSet.OEM_CHARSET">
<summary>Specifies a mapping to one of the OEM code pages, according to the current system locale setting.</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.LogFontCharSet.JOHAB_CHARSET">
<summary>Also spelled "Johap". Specifies the Johab Korean character set.</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.LogFontCharSet.HEBREW_CHARSET">
<summary>Specifies the Hebrew character set.</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.LogFontCharSet.ARABIC_CHARSET">
<summary>Specifies the Arabic character set.</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.LogFontCharSet.GREEK_CHARSET">
<summary>Specifies the Greek character set.</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.LogFontCharSet.TURKISH_CHARSET">
<summary>Specifies the Turkish character set.</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.LogFontCharSet.VIETNAMESE_CHARSET">
<summary>Specifies the Vietnamese character set.</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.LogFontCharSet.THAI_CHARSET">
<summary>Specifies the Thai character set.</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.LogFontCharSet.EASTEUROPE_CHARSET">
<summary>Specifies a Eastern European character set.</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.LogFontCharSet.RUSSIAN_CHARSET">
<summary>Specifies the Russian Cyrillic character set.</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.LogFontCharSet.MAC_CHARSET">
<summary>Specifies the Apple Macintosh character set.</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.LogFontCharSet.BALTIC_CHARSET">
<summary>Specifies the Baltic (Northeastern European) character set.</summary>
</member>
<member name="T:Vanara.PInvoke.Gdi32.LogFontClippingPrecision">
<summary>The clipping precision defines how to clip characters that are partially outside the clipping region.</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.LogFontClippingPrecision.CLIP_CHARACTER_PRECIS">
<summary>Not used.</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.LogFontClippingPrecision.CLIP_DEFAULT_PRECIS">
<summary>Specifies default clipping behavior.</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.LogFontClippingPrecision.CLIP_DFA_DISABLE">
<summary>
Windows XP SP1: Turns off font association for the font. Note that this flag is not guaranteed to have any effect on any platform after Windows
Server 2003.
</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.LogFontClippingPrecision.CLIP_DFA_OVERRIDE">
<summary>
Turns off font association for the font. This is identical to CLIP_DFA_DISABLE, but it can have problems in some situations; the recommended flag
to use is CLIP_DFA_DISABLE.
</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.LogFontClippingPrecision.CLIP_EMBEDDED">
<summary>You must specify this flag to use an embedded read-only font.</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.LogFontClippingPrecision.CLIP_LH_ANGLES">
<summary>
When this value is used, the rotation for all fonts depends on whether the orientation of the coordinate system is left-handed or right-handed.
If not used, device fonts always rotate counterclockwise, but the rotation of other fonts is dependent on the orientation of the coordinate system.
</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.LogFontClippingPrecision.CLIP_MASK">
<summary>Not used.</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.LogFontClippingPrecision.CLIP_STROKE_PRECIS">
<summary>
Not used by the font mapper, but is returned when raster, vector, or TrueType fonts are enumerated. For compatibility, this value is always
returned when enumerating fonts.
</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.LogFontClippingPrecision.CLIP_TT_ALWAYS">
<summary>Not used.</summary>
</member>
<member name="T:Vanara.PInvoke.Gdi32.LogFontFontFamily">
<summary>
Font families describe the look of a font in a general way. They are intended for specifying fonts when the exact typeface desired is not available.
</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.LogFontFontFamily.FF_DONTCARE">
<summary>Use default font.</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.LogFontFontFamily.FF_ROMAN">
<summary>Fonts with variable stroke width (proportional) and with serifs. MS Serif is an example.</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.LogFontFontFamily.FF_SWISS">
<summary>Fonts with variable stroke width (proportional) and without serifs. MS Sans Serif is an example.</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.LogFontFontFamily.FF_MODERN">
<summary>
Fonts with constant stroke width (monospace), with or without serifs. Monospace fonts are usually modern. Pica, Elite, and CourierNew are examples.
</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.LogFontFontFamily.FF_SCRIPT">
<summary>Fonts designed to look like handwriting. Script and Cursive are examples.</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.LogFontFontFamily.FF_DECORATIVE">
<summary>Novelty fonts. Old English is an example.</summary>
</member>
<member name="T:Vanara.PInvoke.Gdi32.LogFontOutputPrecision">
<summary>
The output precision. The output precision defines how closely the output must match the requested font's height, width, character orientation,
escapement, pitch, and font type.
</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.LogFontOutputPrecision.OUT_CHARACTER_PRECIS">
<summary>Not used.</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.LogFontOutputPrecision.OUT_DEFAULT_PRECIS">
<summary>Specifies the default font mapper behavior.</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.LogFontOutputPrecision.OUT_DEVICE_PRECIS">
<summary>Instructs the font mapper to choose a Device font when the system contains multiple fonts with the same name.</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.LogFontOutputPrecision.OUT_OUTLINE_PRECIS">
<summary>This value instructs the font mapper to choose from TrueType and other outline-based fonts.</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.LogFontOutputPrecision.OUT_PS_ONLY_PRECIS">
<summary>
Instructs the font mapper to choose from only PostScript fonts. If there are no PostScript fonts installed in the system, the font mapper returns
to default behavior.
</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.LogFontOutputPrecision.OUT_RASTER_PRECIS">
<summary>Instructs the font mapper to choose a raster font when the system contains multiple fonts with the same name.</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.LogFontOutputPrecision.OUT_SCREEN_OUTLINE_PRECIS">
<summary>A value that specifies a preference for TrueType and other outline fonts.</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.LogFontOutputPrecision.OUT_STRING_PRECIS">
<summary>This value is not used by the font mapper, but it is returned when raster fonts are enumerated.</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.LogFontOutputPrecision.OUT_STROKE_PRECIS">
<summary>This value is not used by the font mapper, but it is returned when TrueType, other outline-based fonts, and vector fonts are enumerated.</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.LogFontOutputPrecision.OUT_TT_ONLY_PRECIS">
<summary>
Instructs the font mapper to choose from only TrueType fonts. If there are no TrueType fonts installed in the system, the font mapper returns to
default behavior.
</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.LogFontOutputPrecision.OUT_TT_PRECIS">
<summary>Instructs the font mapper to choose a TrueType font when the system contains multiple fonts with the same name.</summary>
</member>
<member name="T:Vanara.PInvoke.Gdi32.LogFontOutputQuality">
<summary>
The output quality defines how carefully the graphics device interface (GDI) must attempt to match the logical-font attributes to those of an actual
physical font.
</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.LogFontOutputQuality.DEFAULT_QUALITY">
<summary>Appearance of the font does not matter.</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.LogFontOutputQuality.DRAFT_QUALITY">
<summary>
Appearance of the font is less important than when PROOF_QUALITY is used. For GDI raster fonts, scaling is enabled, which means that more font
sizes are available, but the quality may be lower. Bold, italic, underline, and strikeout fonts are synthesized if necessary.
</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.LogFontOutputQuality.PROOF_QUALITY">
<summary>
Character quality of the font is more important than exact matching of the logical-font attributes. For GDI raster fonts, scaling is disabled and
the font closest in size is chosen. Although the chosen font size may not be mapped exactly when PROOF_QUALITY is used, the quality of the font
is high and there is no distortion of appearance. Bold, italic, underline, and strikeout fonts are synthesized if necessary.
</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.LogFontOutputQuality.NONANTIALIASED_QUALITY">
<summary>Font is never antialiased.</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.LogFontOutputQuality.ANTIALIASED_QUALITY">
<summary>Font is always antialiased if the font supports it and the size of the font is not too small or too large.</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.LogFontOutputQuality.CLEARTYPE_QUALITY">
<summary>
If set, text is rendered (when possible) using ClearType antialiasing method. The font quality is given less importance than maintaining the text size.
</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.LogFontOutputQuality.CLEARTYPE_NATURAL_QUALITY">
<summary>
If set, text is rendered (when possible) using ClearType antialiasing method. The font quality is given more importance than maintaining the text size.
</summary>
</member>
<member name="T:Vanara.PInvoke.Gdi32.LogFontPitch">
<summary>The pitch of the font.</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.LogFontPitch.DEFAULT_PITCH">
<summary>The default pitch.</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.LogFontPitch.FIXED_PITCH">
<summary>The pitch is fixed.</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.LogFontPitch.VARIABLE_PITCH">
<summary>The pitch is variable.</summary>
</member>
<member name="T:Vanara.PInvoke.Gdi32.RasterOperationMode">
<summary>
Defines how the color data for the source rectangle is to be combined with the color data for the destination rectangle to achieve the final color
when using the <see cref="M:Vanara.PInvoke.Gdi32.BitBlt(Vanara.PInvoke.Gdi32.SafeDCHandle,System.Int32,System.Int32,System.Int32,System.Int32,Vanara.PInvoke.Gdi32.SafeDCHandle,System.Int32,System.Int32,Vanara.PInvoke.Gdi32.RasterOperationMode)" /> function.
</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.RasterOperationMode.SRCCOPY">
<summary>Copies the source rectangle directly to the destination rectangle.</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.RasterOperationMode.SRCPAINT">
<summary>Combines the colors of the source and destination rectangles by using the Boolean OR operator.</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.RasterOperationMode.SRCAND">
<summary>Combines the colors of the source and destination rectangles by using the Boolean AND operator.</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.RasterOperationMode.SRCINVERT">
<summary>Combines the colors of the source and destination rectangles by using the Boolean XOR operator.</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.RasterOperationMode.SRCERASE">
<summary>Combines the inverted colors of the destination rectangle with the colors of the source rectangle by using the Boolean AND operator.</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.RasterOperationMode.NOTSRCCOPY">
<summary></summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.RasterOperationMode.NOTSRCERASE">
<summary>Copies the inverted source rectangle to the destination.</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.RasterOperationMode.MERGECOPY">
<summary>Merges the colors of the source rectangle with the brush currently selected in hdcDest, by using the Boolean AND operator.</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.RasterOperationMode.MERGEPAINT">
<summary>Merges the colors of the inverted source rectangle with the colors of the destination rectangle by using the Boolean OR operator.</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.RasterOperationMode.PATCOPY">
<summary>Copies the brush currently selected in hdcDest, into the destination bitmap.</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.RasterOperationMode.PATPAINT">
<summary>
Combines the colors of the brush currently selected in hdcDest, with the colors of the inverted source rectangle by using the Boolean OR
operator. The result of this operation is combined with the colors of the destination rectangle by using the Boolean OR operator.
</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.RasterOperationMode.PATINVERT">
<summary>
Combines the colors of the brush currently selected in hdcDest, with the colors of the destination rectangle by using the Boolean XOR operator.
</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.RasterOperationMode.DSTINVERT">
<summary>Inverts the destination rectangle.</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.RasterOperationMode.BLACKNESS">
<summary>
Fills the destination rectangle using the color associated with index 0 in the physical palette. (This color is black for the default physical palette.)
</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.RasterOperationMode.WHITENESS">
<summary>
Fills the destination rectangle using the color associated with index 1 in the physical palette. (This color is white for the default physical palette.)
</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.RasterOperationMode.NOMIRRORBITMAP">
<summary>Prevents the bitmap from being mirrored.</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.RasterOperationMode.CAPTUREBLT">
<summary>
Includes any windows that are layered on top of your window in the resulting image.By default, the image only contains your window.Note that this
generally cannot be used for printing device contexts.
</summary>
</member>
<member name="T:Vanara.PInvoke.Gdi32.RGBQUAD">
<summary>The RGBQUAD structure describes a color consisting of relative intensities of red, green, and blue.</summary>
</member>
<member name="P:Vanara.PInvoke.Gdi32.RGBQUAD.Color">
<summary>Gets or sets the color associated with the <see cref="T:Vanara.PInvoke.Gdi32.RGBQUAD" /> structure.</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.RGBQUAD.rgbBlue">
<summary>The intensity of blue in the color.</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.RGBQUAD.rgbGreen">
<summary>The intensity of green in the color.</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.RGBQUAD.rgbRed">
<summary>The intensity of red in the color.</summary>
</member>
<member name="F:Vanara.PInvoke.Gdi32.RGBQUAD.rgbReserved">
<summary>This member is reserved and must be zero.</summary>
</member>
<member name="T:Vanara.PInvoke.Gdi32.SafeDCHandle">
<summary>A SafeHandle to track DC handles.</summary>
</member>
<member name="M:Vanara.PInvoke.Gdi32.SafeDCHandle.#ctor(System.Drawing.IDeviceContext)">
<summary>Initializes a new instance of the <see cref="T:Vanara.PInvoke.Gdi32.SafeDCHandle" /> class.</summary>
<param name="dc">An <see cref="T:System.Drawing.IDeviceContext" /> instance.</param>
</member>
<member name="M:Vanara.PInvoke.Gdi32.SafeDCHandle.#ctor(System.IntPtr,System.Boolean)">
<summary>Initializes a new instance of the <see cref="T:Vanara.PInvoke.Gdi32.SafeDCHandle" /> class.</summary>
<param name="hDC">The handle to the DC.</param>
<param name="ownsHandle">
<see langword="true" /> to have the native handle released when this safe handle is disposed or finalized; <see langword="false" /> otherwise.
</param>
</member>
<member name="M:Vanara.PInvoke.Gdi32.SafeDCHandle.GetCompatibleDCHandle">
<summary>Gets the compatible device context handle.</summary>
<returns>
<markup>
<include item="SMCMissingTag">
<parameter>returns</parameter>
<parameter>M:Vanara.PInvoke.Gdi32.SafeDCHandle.GetCompatibleDCHandle</parameter>
</include>
</markup>
</returns>
</member>
<member name="F:Vanara.PInvoke.Gdi32.SafeDCHandle.Null">
<summary>A null handle.</summary>
</member>
<member name="M:Vanara.PInvoke.Gdi32.SafeDCHandle.op_Explicit(Vanara.PInvoke.Gdi32.SafeDCHandle)~System.Drawing.Graphics">
<summary>Performs an explicit conversion from <see cref="T:Vanara.PInvoke.Gdi32.SafeDCHandle" /> to <see cref="T:System.Drawing.Graphics" />.</summary>
<param name="hdc">The HDC.</param>
<returns>The result of the conversion.</returns>
</member>
<member name="M:Vanara.PInvoke.Gdi32.SafeDCHandle.op_Implicit(System.Drawing.Graphics)~Vanara.PInvoke.Gdi32.SafeDCHandle">
<summary>Performs an implicit conversion from <see cref="T:System.Drawing.Graphics" /> to <see cref="T:Vanara.PInvoke.Gdi32.SafeDCHandle" />.</summary>
<param name="graphics">The <see cref="T:System.Drawing.Graphics" /> instance.</param>
<returns>The result of the conversion.</returns>
</member>
<member name="M:Vanara.PInvoke.Gdi32.SafeDCHandle.ReleaseHandle">
<summary>When overridden in a derived class, executes the code required to free the handle.</summary>
<returns>true if the handle is released successfully; otherwise, in the event of a catastrophic failure, false. In this case, it generates a releaseHandleFailed MDA Managed Debugging Assistant.</returns>
</member>
<member name="P:Vanara.PInvoke.Gdi32.SafeDCHandle.ScreenCompatibleDCHandle">
<summary>Gets the screen compatible device context handle.</summary>
</member>
<member name="T:Vanara.PInvoke.Gdi32.SafeDCObjectHandle">
<summary>
<markup>
<include item="SMCMissingTag">
<parameter>summary</parameter>
<parameter>T:Vanara.PInvoke.Gdi32.SafeDCObjectHandle</parameter>
</include>
</markup>
</summary>
</member>
<member name="M:Vanara.PInvoke.Gdi32.SafeDCObjectHandle.#ctor(Vanara.PInvoke.Gdi32.SafeDCHandle,System.IntPtr)">
<summary>
<markup>
<include item="SMCAutoDocConstructor">
<parameter>Vanara.PInvoke.Gdi32.SafeDCObjectHandle</parameter>
</include>
</markup>
</summary>
<param name="hdc">
<markup>
<include item="SMCMissingParamTag">
<parameter>param</parameter>
<parameter>hdc</parameter>
<parameter>M:Vanara.PInvoke.Gdi32.SafeDCObjectHandle.#ctor(Vanara.PInvoke.Gdi32.SafeDCHandle,System.IntPtr)</parameter>
</include>
</markup>
</param>
<param name="hObj">
<markup>
<include item="SMCMissingParamTag">
<parameter>param</parameter>
<parameter>hObj</parameter>
<parameter>M:Vanara.PInvoke.Gdi32.SafeDCObjectHandle.#ctor(Vanara.PInvoke.Gdi32.SafeDCHandle,System.IntPtr)</parameter>
</include>
</markup>
</param>
</member>
<member name="M:Vanara.PInvoke.Gdi32.SafeDCObjectHandle.ReleaseHandle">
<summary>
<markup>
<include item="SMCMissingTag">
<parameter>summary</parameter>
<parameter>M:Vanara.PInvoke.Gdi32.SafeDCObjectHandle.ReleaseHandle</parameter>
</include>
</markup>
</summary>
<returns>
<markup>
<include item="SMCMissingTag">
<parameter>returns</parameter>
<parameter>M:Vanara.PInvoke.Gdi32.SafeDCObjectHandle.ReleaseHandle</parameter>
</include>
</markup>
</returns>
</member>
</members>
</doc>

File diff suppressed because it is too large Load Diff

View File

@ -0,0 +1,339 @@
<?xml version="1.0" encoding="utf-8"?>
<doc>
<assembly>
<name>Vanara.PInvoke.NTDSApi</name>
</assembly>
<members>
<member name="T:Vanara.PInvoke.NTDSApi">
<summary>Platform invokable enumerated types, constants and functions from ntdsapi.h</summary>
</member>
<member name="M:Vanara.PInvoke.NTDSApi.DsBind(System.String,System.String,System.IntPtr@)">
<summary>
The DsBind function binds to a domain controller.DsBind uses the default process credentials to bind to the domain controller. To specify alternate
credentials, use the DsBindWithCred function.
</summary>
<param name="DomainControllerName">
Pointer to a null-terminated string that contains the name of the domain controller to bind to. This name can be the name of the domain controller or
the fully qualified DNS name of the domain controller. Either name type can, optionally, be preceded by two backslash characters. All of the
following examples represent correctly formatted domain controller names:
<list type="bullet"><item><definition>"FAB-DC-01"</definition></item><item><definition>"\\FAB-DC-01"</definition></item><item><definition>"FAB-DC-01.fabrikam.com"</definition></item><item><definition>"\\FAB-DC-01.fabrikam.com"</definition></item></list><para>This parameter can be NULL. For more information, see Remarks.</para></param>
<param name="DnsDomainName">
Pointer to a null-terminated string that contains the fully qualified DNS name of the domain to bind to. This parameter can be NULL. For more
information, see Remarks.
</param>
<param name="phDS">Address of a HANDLE value that receives the binding handle. To close this handle, pass it to the DsUnBind function.</param>
<returns>Returns ERROR_SUCCESS if successful or a Windows or RPC error code otherwise.</returns>
</member>
<member name="M:Vanara.PInvoke.NTDSApi.DsBindWithCred(System.String,System.String,Vanara.PInvoke.NTDSApi.SafeDsPasswordCredentialsHandle,System.IntPtr@)">
<summary>The DsBindWithCred function binds to a domain controller using the specified credentials.</summary>
<param name="DomainControllerName">
Pointer to a null-terminated string that contains the name of the domain controller to bind to. This name can be the name of the domain controller or
the fully qualified DNS name of the domain controller. Either name type can, optionally, be preceded by two backslash characters. All of the
following examples represent correctly formatted domain controller names:
<list type="bullet"><item><definition>"FAB-DC-01"</definition></item><item><definition>"\\FAB-DC-01"</definition></item><item><definition>"FAB-DC-01.fabrikam.com"</definition></item><item><definition>"\\FAB-DC-01.fabrikam.com"</definition></item></list><para>This parameter can be NULL. For more information, see Remarks.</para></param>
<param name="DnsDomainName">
Pointer to a null-terminated string that contains the fully qualified DNS name of the domain to bind to. This parameter can be NULL. For more
information, see Remarks.
</param>
<param name="AuthIdentity">
Contains an RPC_AUTH_IDENTITY_HANDLE value that represents the credentials to be used for the bind. The DsMakePasswordCredentials function is used to
obtain this value. If this parameter is NULL, the credentials of the calling thread are used.
<para>DsUnBind must be called before freeing this handle with the DsFreePasswordCredentials function.</para></param>
<param name="phDS">Address of a HANDLE value that receives the binding handle. To close this handle, pass it to the DsUnBind function.</param>
<returns>Returns ERROR_SUCCESS if successful or a Windows or RPC error code otherwise.</returns>
</member>
<member name="M:Vanara.PInvoke.NTDSApi.DsCrackNames(Vanara.PInvoke.NTDSApi.SafeDsHandle,System.String[],Vanara.PInvoke.NTDSApi.DS_NAME_FORMAT,Vanara.PInvoke.NTDSApi.DS_NAME_FORMAT,Vanara.PInvoke.NTDSApi.DS_NAME_FLAGS)">
<summary>A wrapper function for the DsCrackNames OS call</summary>
<param name="hSafeDs">
Contains a directory service handle obtained from either the DSBind or DSBindWithCred function. If flags contains DS_NAME_FLAG_SYNTACTICAL_ONLY, hDS
can be NULL.
</param>
<param name="names">The names to be converted.</param>
<param name="formatDesired">
Contains one of the DS_NAME_FORMAT values that identifies the format of the output names. The DS_SID_OR_SID_HISTORY_NAME value is not supported.
</param>
<param name="formatOffered">Contains one of the DS_NAME_FORMAT values that identifies the format of the input names.</param>
<param name="flags">Contains one or m ore of the DS_NAME_FLAGS values used to determine how the name syntax will be cracked.</param>
<returns>The crack results.</returns>
</member>
<member name="M:Vanara.PInvoke.NTDSApi.DsCrackNames(Vanara.PInvoke.NTDSApi.SafeDsHandle,Vanara.PInvoke.NTDSApi.DS_NAME_FLAGS,Vanara.PInvoke.NTDSApi.DS_NAME_FORMAT,Vanara.PInvoke.NTDSApi.DS_NAME_FORMAT,System.UInt32,System.String[],Vanara.PInvoke.NTDSApi.SafeDsNameResult@)">
<summary>
The DsCrackNames function converts an array of directory service object names from one format to another. Name conversion enables client applications
to map between the multiple names used to identify various directory service objects. For example, user objects can be identified by SAM account
names (Domain\UserName), user principal name (UserName@Domain.com), or distinguished name.
<note type="note">This function uses many handles and memory allocations that can be unwieldy. It is recommended to use the
<see cref="M:Vanara.PInvoke.NTDSApi.DsCrackNames(Vanara.PInvoke.NTDSApi.SafeDsHandle,System.String[],Vanara.PInvoke.NTDSApi.DS_NAME_FORMAT,Vanara.PInvoke.NTDSApi.DS_NAME_FORMAT,Vanara.PInvoke.NTDSApi.DS_NAME_FLAGS)" /> method instead.</note></summary>
<param name="hSafeDs">
Contains a directory service handle obtained from either the DSBind or DSBindWithCred function. If flags contains DS_NAME_FLAG_SYNTACTICAL_ONLY, hDS
can be NULL.
</param>
<param name="flags">Contains one or more of the DS_NAME_FLAGS values used to determine how the name syntax will be cracked.</param>
<param name="formatOffered">Contains one of the DS_NAME_FORMAT values that identifies the format of the input names.</param>
<param name="formatDesired">
Contains one of the DS_NAME_FORMAT values that identifies the format of the output names. The DS_SID_OR_SID_HISTORY_NAME value is not supported.
</param>
<param name="cNames">Contains the number of elements in the rpNames array.</param>
<param name="rpNames">Pointer to an array of pointers to null-terminated strings that contain names to be converted.</param>
<param name="ppResult">
Pointer to a PDS_NAME_RESULT value that receives a DS_NAME_RESULT structure that contains the converted names. The caller must free this memory, when
it is no longer required, by calling DsFreeNameResult.
</param>
<returns>Returns a Win32 error value, an RPC error value, or one of the following.</returns>
</member>
<member name="M:Vanara.PInvoke.NTDSApi.DsFreeNameResult(System.IntPtr)">
<summary>
The DsFreeNameResult function frees the memory held by a DS_NAME_RESULT structure. Use this function to free the memory allocated by the DsCrackNames function.
</summary>
<param name="pResult">Pointer to the DS_NAME_RESULT structure to be freed.</param>
</member>
<member name="M:Vanara.PInvoke.NTDSApi.DsFreePasswordCredentials(System.IntPtr)">
<summary>Frees memory allocated for a credentials structure by the DsMakePasswordCredentials function.</summary>
<param name="AuthIdentity">Handle of the credential structure to be freed.</param>
</member>
<member name="M:Vanara.PInvoke.NTDSApi.DsMakePasswordCredentials(System.String,System.String,System.String,System.IntPtr@)">
<summary>Constructs a credential handle suitable for use with the DsBindWithCred function.</summary>
<param name="User">A string that contains the user name to use for the credentials.</param>
<param name="Domain">A string that contains the domain that the user is a member of.</param>
<param name="Password">A string that contains the password to use for the credentials.</param>
<param name="pAuthIdentity">
An RPC_AUTH_IDENTITY_HANDLE value that receives the credential handle. This handle is used in a subsequent call to DsBindWithCred. This handle must
be freed with the DsFreePasswordCredentials function when it is no longer required.
</param>
<returns>Returns a Windows error code.</returns>
</member>
<member name="M:Vanara.PInvoke.NTDSApi.DsUnBind(System.IntPtr@)">
<summary>The DsUnBind function finds an RPC session with a domain controller and unbinds a handle to the directory service (DS).</summary>
<param name="phDS">Pointer to a bind handle to the directory service. This handle is provided by a call to DsBind, DsBindWithCred, or DsBindWithSpn.</param>
<returns>0</returns>
</member>
<member name="T:Vanara.PInvoke.NTDSApi.DS_NAME_ERROR">
<summary>
Defines the errors returned by the status member of the <see cref="T:Vanara.PInvoke.NTDSApi.DS_NAME_RESULT_ITEM" /> structure. These are potential errors that may be
encountered while a name is converted by the <see cref="M:Vanara.PInvoke.NTDSApi.DsCrackNames(Vanara.PInvoke.NTDSApi.SafeDsHandle,System.String[],Vanara.PInvoke.NTDSApi.DS_NAME_FORMAT,Vanara.PInvoke.NTDSApi.DS_NAME_FORMAT,Vanara.PInvoke.NTDSApi.DS_NAME_FLAGS)" /> function.
</summary>
</member>
<member name="F:Vanara.PInvoke.NTDSApi.DS_NAME_ERROR.DS_NAME_NO_ERROR">
<summary>The conversion was successful.</summary>
</member>
<member name="F:Vanara.PInvoke.NTDSApi.DS_NAME_ERROR.DS_NAME_ERROR_RESOLVING">
<summary>A generic processing error occurred.</summary>
</member>
<member name="F:Vanara.PInvoke.NTDSApi.DS_NAME_ERROR.DS_NAME_ERROR_NOT_FOUND">
<summary>The name cannot be found or the caller does not have permission to access the name.</summary>
</member>
<member name="F:Vanara.PInvoke.NTDSApi.DS_NAME_ERROR.DS_NAME_ERROR_NOT_UNIQUE">
<summary>The input name is mapped to more than one output name or the desired format did not have a single, unique value for the object found.</summary>
</member>
<member name="F:Vanara.PInvoke.NTDSApi.DS_NAME_ERROR.DS_NAME_ERROR_NO_MAPPING">
<summary>
The input name was found, but the associated output format cannot be found. This can occur if the object does not have all the required attributes.
</summary>
</member>
<member name="F:Vanara.PInvoke.NTDSApi.DS_NAME_ERROR.DS_NAME_ERROR_DOMAIN_ONLY">
<summary>
Unable to resolve entire name, but was able to determine in which domain object resides. The caller is expected to retry the call at a domain
controller for the specified domain. The entire name cannot be resolved, but the domain that the object resides in could be determined. The
pDomain member of the DS_NAME_RESULT_ITEM contains valid data when this error is specified.
</summary>
</member>
<member name="F:Vanara.PInvoke.NTDSApi.DS_NAME_ERROR.DS_NAME_ERROR_NO_SYNTACTICAL_MAPPING">
<summary>A syntactical mapping cannot be performed on the client without transmitting over the network.</summary>
</member>
<member name="F:Vanara.PInvoke.NTDSApi.DS_NAME_ERROR.DS_NAME_ERROR_TRUST_REFERRAL">
<summary>The name is from an external trusted forest.</summary>
</member>
<member name="T:Vanara.PInvoke.NTDSApi.DS_NAME_FLAGS">
<summary>
Used to define how the name syntax will be cracked. These flags are used by the <see cref="M:Vanara.PInvoke.NTDSApi.DsCrackNames(Vanara.PInvoke.NTDSApi.SafeDsHandle,System.String[],Vanara.PInvoke.NTDSApi.DS_NAME_FORMAT,Vanara.PInvoke.NTDSApi.DS_NAME_FORMAT,Vanara.PInvoke.NTDSApi.DS_NAME_FLAGS)" /> function.
</summary>
</member>
<member name="F:Vanara.PInvoke.NTDSApi.DS_NAME_FLAGS.DS_NAME_NO_FLAGS">
<summary>Indicates that there are no associated flags.</summary>
</member>
<member name="F:Vanara.PInvoke.NTDSApi.DS_NAME_FLAGS.DS_NAME_FLAG_SYNTACTICAL_ONLY">
<summary>
Performs a syntactical mapping at the client without transferring over the network. The only syntactic mapping supported is from
DS_FQDN_1779_NAME to DS_CANONICAL_NAME or DS_CANONICAL_NAME_EX. <see cref="M:Vanara.PInvoke.NTDSApi.DsCrackNames(Vanara.PInvoke.NTDSApi.SafeDsHandle,System.String[],Vanara.PInvoke.NTDSApi.DS_NAME_FORMAT,Vanara.PInvoke.NTDSApi.DS_NAME_FORMAT,Vanara.PInvoke.NTDSApi.DS_NAME_FLAGS)" />
returns the DS_NAME_ERROR_NO_SYNTACTICAL_MAPPING flag if a syntactical mapping is not possible.
</summary>
</member>
<member name="F:Vanara.PInvoke.NTDSApi.DS_NAME_FLAGS.DS_NAME_FLAG_EVAL_AT_DC">
<summary>Forces a trip to the domain controller for evaluation, even if the syntax could be cracked locally.</summary>
</member>
<member name="F:Vanara.PInvoke.NTDSApi.DS_NAME_FLAGS.DS_NAME_FLAG_GCVERIFY">
<summary>The call fails if the domain controller is not a global catalog server.</summary>
</member>
<member name="F:Vanara.PInvoke.NTDSApi.DS_NAME_FLAGS.DS_NAME_FLAG_TRUST_REFERRAL">
<summary>Enables cross forest trust referral.</summary>
</member>
<member name="T:Vanara.PInvoke.NTDSApi.DS_NAME_FORMAT">
<summary>
Provides formats to use for input and output names for the <see cref="M:Vanara.PInvoke.NTDSApi.DsCrackNames(Vanara.PInvoke.NTDSApi.SafeDsHandle,System.String[],Vanara.PInvoke.NTDSApi.DS_NAME_FORMAT,Vanara.PInvoke.NTDSApi.DS_NAME_FORMAT,Vanara.PInvoke.NTDSApi.DS_NAME_FLAGS)" /> function.
</summary>
</member>
<member name="F:Vanara.PInvoke.NTDSApi.DS_NAME_FORMAT.DS_UNKNOWN_NAME">
<summary>
Indicates the name is using an unknown name type. This format can impact performance because it forces the server to attempt to match all
possible formats. Only use this value if the input format is unknown.
</summary>
</member>
<member name="F:Vanara.PInvoke.NTDSApi.DS_NAME_FORMAT.DS_FQDN_1779_NAME">
<summary>
Indicates that the fully qualified distinguished name is used. For example: CN = someone, OU = Users, DC = Engineering, DC = Fabrikam, DC = Com
</summary>
</member>
<member name="F:Vanara.PInvoke.NTDSApi.DS_NAME_FORMAT.DS_NT4_ACCOUNT_NAME">
<summary>
Indicates a Windows NT 4.0 account name. For example: Engineering\someone The domain-only version includes two trailing backslashes (\\).
</summary>
</member>
<member name="F:Vanara.PInvoke.NTDSApi.DS_NAME_FORMAT.DS_DISPLAY_NAME">
<summary>
Indicates a user-friendly display name, for example, Jeff Smith. The display name is not necessarily the same as relative distinguished name (RDN).
</summary>
</member>
<member name="F:Vanara.PInvoke.NTDSApi.DS_NAME_FORMAT.DS_UNIQUE_ID_NAME">
<summary>Indicates a GUID string that the IIDFromString function returns. For example: {4fa050f0-f561-11cf-bdd9-00aa003a77b6}</summary>
</member>
<member name="F:Vanara.PInvoke.NTDSApi.DS_NAME_FORMAT.DS_CANONICAL_NAME">
<summary>
Indicates a complete canonical name. For example: engineering.fabrikam.com/software/someone The domain-only version includes a trailing forward
slash (/).
</summary>
</member>
<member name="F:Vanara.PInvoke.NTDSApi.DS_NAME_FORMAT.DS_USER_PRINCIPAL_NAME">
<summary>Indicates that it is using the user principal name (UPN). For example: someone@engineering.fabrikam.com</summary>
</member>
<member name="F:Vanara.PInvoke.NTDSApi.DS_NAME_FORMAT.DS_CANONICAL_NAME_EX">
<summary>
This element is the same as DS_CANONICAL_NAME except that the rightmost forward slash (/) is replaced with a newline character (\n), even in a
domain-only case. For example: engineering.fabrikam.com/software\nsomeone
</summary>
</member>
<member name="F:Vanara.PInvoke.NTDSApi.DS_NAME_FORMAT.DS_SERVICE_PRINCIPAL_NAME">
<summary>Indicates it is using a generalized service principal name. For example: www/www.fabrikam.com@fabrikam.com</summary>
</member>
<member name="F:Vanara.PInvoke.NTDSApi.DS_NAME_FORMAT.DS_SID_OR_SID_HISTORY_NAME">
<summary>
Indicates a Security Identifier (SID) for the object. This can be either the current SID or a SID from the object SID history. The SID string can
use either the standard string representation of a SID, or one of the string constants defined in Sddl.h. For more information about converting a
binary SID into a SID string, see SID Strings. The following is an example of a SID string: S-1-5-21-397955417-626881126-188441444-501
</summary>
</member>
<member name="F:Vanara.PInvoke.NTDSApi.DS_NAME_FORMAT.DS_DNS_DOMAIN_NAME">
<summary>Not supported by the Directory Service (DS) APIs.</summary>
</member>
<member name="F:Vanara.PInvoke.NTDSApi.DS_NAME_FORMAT.DS_LIST_NCS">
<summary>
This causes DsCrackNames to return the distinguished names of all naming contexts in the current forest. The formatDesired parameter is ignored.
cNames must be at least one and all strings in rpNames must have a length greater than zero characters. The contents of the rpNames strings is ignored.
</summary>
</member>
<member name="T:Vanara.PInvoke.NTDSApi.DS_NAME_RESULT">
<summary>Used with the DsCrackNames function to contain the names converted by the function.</summary>
</member>
<member name="F:Vanara.PInvoke.NTDSApi.DS_NAME_RESULT.cItems">
<summary>Contains the number of elements in the rItems array.</summary>
</member>
<member name="P:Vanara.PInvoke.NTDSApi.DS_NAME_RESULT.Items">
<summary>Enumeration of DS_NAME_RESULT_ITEM structures. Each element of this array represents a single converted name.</summary>
</member>
<member name="F:Vanara.PInvoke.NTDSApi.DS_NAME_RESULT.rItems">
<summary>Contains an array of DS_NAME_RESULT_ITEM structure pointers. Each element of this array represents a single converted name.</summary>
</member>
<member name="T:Vanara.PInvoke.NTDSApi.DS_NAME_RESULT_ITEM">
<summary>Contains a name converted by the DsCrackNames function, along with associated error and domain data.</summary>
</member>
<member name="F:Vanara.PInvoke.NTDSApi.DS_NAME_RESULT_ITEM.pDomain">
<summary>
A string that specifies the DNS domain in which the object resides. This member will contain valid data if status contains DS_NAME_NO_ERROR or DS_NAME_ERROR_DOMAIN_ONLY.
</summary>
</member>
<member name="F:Vanara.PInvoke.NTDSApi.DS_NAME_RESULT_ITEM.pName">
<summary>A string that specifies the newly formatted object name.</summary>
</member>
<member name="F:Vanara.PInvoke.NTDSApi.DS_NAME_RESULT_ITEM.status">
<summary>Contains one of the DS_NAME_ERROR values that indicates the status of this name conversion.</summary>
</member>
<member name="M:Vanara.PInvoke.NTDSApi.DS_NAME_RESULT_ITEM.ToString">
<summary>Returns a <see cref="T:System.String" /> that represents this instance.</summary>
<returns>A <see cref="T:System.String" /> that represents this instance.</returns>
</member>
<member name="T:Vanara.PInvoke.NTDSApi.SafeDsHandle">
<summary>A <see cref="T:System.Runtime.InteropServices.SafeHandle" /> for handles bound to directory services.</summary>
</member>
<member name="M:Vanara.PInvoke.NTDSApi.SafeDsHandle.#ctor">
<summary>Initializes a new instance of the <see cref="T:Vanara.PInvoke.NTDSApi.SafeDsHandle" /> class.</summary>
</member>
<member name="M:Vanara.PInvoke.NTDSApi.SafeDsHandle.#ctor(System.IntPtr)">
<summary>Initializes a new instance of the <see cref="T:Vanara.PInvoke.NTDSApi.SafeDsHandle" /> class from an existing bound handle.</summary>
<param name="hDs">
A handle retrieved from a call to <see cref="M:Vanara.PInvoke.NTDSApi.DsBind(System.String,System.String,System.IntPtr@)" /> or <see cref="M:Vanara.PInvoke.NTDSApi.DsBindWithCred(System.String,System.String,Vanara.PInvoke.NTDSApi.SafeDsPasswordCredentialsHandle,System.IntPtr@)" />.
</param>
</member>
<member name="M:Vanara.PInvoke.NTDSApi.SafeDsHandle.#ctor(System.String,System.String)">
<summary>Initializes a new instance of the <see cref="T:Vanara.PInvoke.NTDSApi.SafeDsHandle" /> class bound to a domain and/or DC.</summary>
<param name="dnsDomainName">
A string that contains the fully qualified DNS name of the domain to bind to. This parameter can be NULL. For more information, see Remarks.
</param>
<param name="domainControllerName">
A string that contains the name of the domain controller to bind to. This name can be the name of the domain controller or the fully qualified
DNS name of the domain controller. Either name type can, optionally, be preceded by two backslash characters. All of the following examples
represent correctly formatted domain controller names:
<list type="bullet"><item><definition>"FAB-DC-01"</definition></item><item><definition>"\\FAB-DC-01"</definition></item><item><definition>"FAB-DC-01.fabrikam.com"</definition></item><item><definition>"\\FAB-DC-01.fabrikam.com"</definition></item></list><para>This parameter can be NULL. For more information, see Remarks.</para></param>
</member>
<member name="M:Vanara.PInvoke.NTDSApi.SafeDsHandle.#ctor(Vanara.PInvoke.NTDSApi.SafeDsPasswordCredentialsHandle,System.String,System.String)">
<summary>Initializes a new instance of the <see cref="T:Vanara.PInvoke.NTDSApi.SafeDsHandle" /> class from a user credential and then bound to a domain and/or DC.</summary>
<param name="authIdentity">
Contains an <see cref="T:Vanara.PInvoke.NTDSApi.SafeDsPasswordCredentialsHandle" /> value that represents the credentials to be used for the bind.
</param>
<param name="dnsDomainName">
A string that contains the fully qualified DNS name of the domain to bind to. This parameter can be NULL. For more information, see Remarks.
</param>
<param name="domainControllerName">
A string that contains the name of the domain controller to bind to. This name can be the name of the domain controller or the fully qualified
DNS name of the domain controller. Either name type can, optionally, be preceded by two backslash characters. All of the following examples
represent correctly formatted domain controller names:
<list type="bullet"><item><definition>"FAB-DC-01"</definition></item><item><definition>"\\FAB-DC-01"</definition></item><item><definition>"FAB-DC-01.fabrikam.com"</definition></item><item><definition>"\\FAB-DC-01.fabrikam.com"</definition></item></list><para>This parameter can be NULL. For more information, see Remarks.</para></param>
</member>
<member name="P:Vanara.PInvoke.NTDSApi.SafeDsHandle.Null">
<summary>Gets a <c>NULL</c> equivalent for a bound directory services handle.</summary>
</member>
<member name="T:Vanara.PInvoke.NTDSApi.SafeDsNameResult">
<summary>
A <see cref="T:System.Runtime.InteropServices.SafeHandle" /> for the results from <see cref="!:Vanara.DsCrackNames(SafeDsHandle,DS_NAME_FLAGS,DS_NAME_FORMAT,DS_NAME_FORMAT,uint,string[],out SafeDsNameResult)" />.
</summary>
</member>
<member name="M:Vanara.PInvoke.NTDSApi.SafeDsNameResult.#ctor">
<summary>Initializes a new instance of the <see cref="T:Vanara.PInvoke.NTDSApi.SafeDsNameResult" /> class.</summary>
</member>
<member name="P:Vanara.PInvoke.NTDSApi.SafeDsNameResult.Items">
<summary>An array of DS_NAME_RESULT_ITEM structures. Each element of this array represents a single converted name.</summary>
</member>
<member name="T:Vanara.PInvoke.NTDSApi.SafeDsPasswordCredentialsHandle">
<summary>
Constructs a <see cref="T:System.Runtime.InteropServices.SafeHandle" /> that encapsulates the value retrieved from <see cref="M:Vanara.PInvoke.NTDSApi.DsMakePasswordCredentials(System.String,System.String,System.String,System.IntPtr@)" />.
</summary>
</member>
<member name="M:Vanara.PInvoke.NTDSApi.SafeDsPasswordCredentialsHandle.#ctor(System.String,System.String)">
<summary>Initializes a new instance of the <see cref="T:Vanara.PInvoke.NTDSApi.SafeDsPasswordCredentialsHandle" /> class from user credentials.</summary>
<param name="user">
String that contains a fully qualified user name to use for the credentials, such as a user in UPN format; for example, "someone@fabrikam.com".
</param>
<param name="password">String that contains the password to use for the credentials.</param>
</member>
<member name="M:Vanara.PInvoke.NTDSApi.SafeDsPasswordCredentialsHandle.#ctor(System.String,System.String,System.String)">
<summary>Initializes a new instance of the <see cref="T:Vanara.PInvoke.NTDSApi.SafeDsPasswordCredentialsHandle" /> class from user credentials.</summary>
<param name="user">String that contains the user name to use for the credentials.</param>
<param name="domain">String that contains the domain that the user is a member of.</param>
<param name="password">String that contains the password to use for the credentials.</param>
</member>
<member name="M:Vanara.PInvoke.NTDSApi.SafeDsPasswordCredentialsHandle.ReleaseHandle">
<summary>When overridden in a derived class, executes the code required to free the handle.</summary>
<returns>
true if the handle is released successfully; otherwise, in the event of a catastrophic failure, false. In this case, it generates a
releaseHandleFailed MDA Managed Debugging Assistant.
</returns>
</member>
</members>
</doc>

View File

@ -0,0 +1,655 @@
<?xml version="1.0" encoding="utf-8"?>
<doc>
<assembly>
<name>Vanara.PInvoke.NetApi32</name>
</assembly>
<members>
<member name="T:Vanara.PInvoke.NetApi32">
<summary>Platform invokable enumerated types, constants and functions from netapi32.h</summary>
</member>
<member name="M:Vanara.PInvoke.NetApi32.DsGetDcName(System.String,System.String,System.IntPtr,System.String,Vanara.PInvoke.NetApi32.DsGetDcNameFlags,Vanara.PInvoke.NetApi32.SafeNetApiBuffer@)">
<summary>
The DsGetDcName function returns the name of a domain controller in a specified domain. This function accepts additional domain controller selection
criteria to indicate preference for a domain controller with particular characteristics.
</summary>
<param name="ComputerName">
Pointer to a null-terminated string that specifies the name of the server to process this function. Typically, this parameter is NULL, which
indicates that the local computer is used.
</param>
<param name="DomainName">
Pointer to a null-terminated string that specifies the name of the domain or application partition to query. This name can either be a DNS style
name, for example, fabrikam.com, or a flat-style name, for example, Fabrikam. If a DNS style name is specified, the name may be specified with or
without a trailing period.
<para>
If the Flags parameter contains the DS_GC_SERVER_REQUIRED flag, DomainName must be the name of the forest. In this case, DsGetDcName fails if
DomainName specifies a name that is not the forest root.
</para><para>
If the Flags parameter contains the DS_GC_SERVER_REQUIRED flag and DomainName is NULL, DsGetDcName attempts to find a global catalog in the forest of
the computer identified by ComputerName, which is the local computer if ComputerName is NULL.
</para><para>
If DomainName is NULL and the Flags parameter does not contain the DS_GC_SERVER_REQUIRED flag, ComputerName is set to the default domain name of the
primary domain of the computer identified by ComputerName.
</para></param>
<param name="DomainGuid">
Pointer to a GUID structure that specifies the GUID of the domain queried. If DomainGuid is not NULL and the domain specified by DomainName or
ComputerName cannot be found, DsGetDcName attempts to locate a domain controller in the domain having the GUID specified by DomainGuid.
</param>
<param name="SiteName">
Pointer to a null-terminated string that specifies the name of the site where the returned domain controller should physically exist. If this
parameter is NULL, DsGetDcName attempts to return a domain controller in the site closest to the site of the computer specified by ComputerName. This
parameter should be NULL, by default.
</param>
<param name="Flags">
Contains a set of flags that provide additional data used to process the request. This parameter can be a combination of the following values.
</param>
<param name="DomainControllerInfo">
Pointer to a PDOMAIN_CONTROLLER_INFO value that receives a pointer to a DOMAIN_CONTROLLER_INFO structure that contains data about the domain
controller selected. This structure is allocated by DsGetDcName. The caller must free the structure using the NetApiBufferFree function when it is no
longer required.
</param>
<returns>
If the function returns domain controller data, the return value is ERROR_SUCCESS.
<para>If the function fails, the return value can be one of the following error codes.</para></returns>
</member>
<member name="F:Vanara.PInvoke.NetApi32.MAX_PREFERRED_LENGTH">
<summary>
A constant of type DWORD that is set to 1. This value is valid as an input parameter to any method that takes a PreferedMaximumLength parameter.
When specified as an input parameter, this value indicates that the method MUST allocate as much space as the data requires.
</summary>
</member>
<member name="M:Vanara.PInvoke.NetApi32.NetApiBufferFree(System.IntPtr)">
<summary>
The NetApiBufferFree function frees the memory that the NetApiBufferAllocate function allocates. Applications should also call NetApiBufferFree to
free the memory that other network management functions use internally to return information.
</summary>
<param name="pBuf">
A pointer to a buffer returned previously by another network management function or memory allocated by calling the NetApiBufferAllocate function.
</param>
<returns>If the function succeeds, the return value is NERR_Success. If the function fails, the return value is a system error code.</returns>
</member>
<member name="M:Vanara.PInvoke.NetApi32.NetServerEnum(System.String,System.Int32,Vanara.PInvoke.NetApi32.SafeNetApiBuffer@,System.Int32,System.Int32@,System.Int32@,Vanara.PInvoke.NetApi32.NetServerEnumFilter,System.String,System.IntPtr)">
<summary>The NetServerEnum function lists all servers of the specified type that are visible in a domain.</summary>
<param name="servernane">Reserved; must be NULL.</param>
<param name="level">The information level of the data requested.</param>
<param name="bufptr">
A pointer to the buffer that receives the data. The format of this data depends on the value of the level parameter. This buffer is allocated by the
system and must be freed using the NetApiBufferFree function. Note that you must free the buffer even if the function fails with ERROR_MORE_DATA.
</param>
<param name="prefmaxlen">
The preferred maximum length of returned data, in bytes. If you specify MAX_PREFERRED_LENGTH, the function allocates the amount of memory required
for the data. If you specify another value in this parameter, it can restrict the number of bytes that the function returns. If the buffer size is
insufficient to hold all entries, the function returns ERROR_MORE_DATA. For more information, see Network Management Function Buffers and Network
Management Function Buffer Lengths.
</param>
<param name="entriesread">A pointer to a value that receives the count of elements actually enumerated.</param>
<param name="totalentries">
A pointer to a value that receives the total number of visible servers and workstations on the network. Note that applications should consider this
value only as a hint.
</param>
<param name="servertype">A value that filters the server entries to return from the enumeration.</param>
<param name="domain">
A pointer to a constant string that specifies the name of the domain for which a list of servers is to be returned. The domain name must be a NetBIOS
domain name (for example, microsoft). The NetServerEnum function does not support DNS-style names (for example, microsoft.com). If this parameter is
NULL, the primary domain is implied.
</param>
<param name="resume_handle">Reserved; must be set to zero.</param>
<returns>If the function succeeds, the return value is NERR_Success.</returns>
</member>
<member name="M:Vanara.PInvoke.NetApi32.NetServerEnum``1(Vanara.PInvoke.NetApi32.NetServerEnumFilter,System.String,System.Int32)">
<summary>The NetServerEnum function lists all servers of the specified type that are visible in a domain.</summary>
<param name="netServerEnumFilter">A value that filters the server entries to return from the enumeration.</param>
<param name="domain">
A string that specifies the name of the domain for which a list of servers is to be returned. The domain name must be a NetBIOS domain name (for
example, Microsoft). The NetServerEnum function does not support DNS-style names (for example, microsoft.com). If this parameter is NULL, the primary
domain is implied.
</param>
<param name="level">
The information level of the data requested. If this value is 0, then the method will extract all digits to form the level (e.g. SERVER_INFO_101
produces 101).
</param>
<typeparam name="T">The type of the structure to have filled in for each server. This must be SERVER_INFO_100 or SERVER_INFO_101.</typeparam>
<returns>A managed array of the requested type.</returns>
</member>
<member name="M:Vanara.PInvoke.NetApi32.NetServerGetInfo``1(System.String,System.Int32)">
<summary>The NetServerGetInfo function retrieves current configuration information for the specified server.</summary>
<param name="serverName">
A string that specifies the name of the remote server on which the function is to execute. If this parameter is NULL, the local computer is used.
</param>
<param name="level">
The information level of the data requested. If this value is 0, then the method will extract all digits to form the level (e.g. SERVER_INFO_101
produces 101).
</param>
<typeparam name="T">The type of the structure to have filled in for each server. This must be SERVER_INFO_100, SERVER_INFO_101, or SERVER_INFO_102.</typeparam>
<returns>The requested type with returned information about the server.</returns>
</member>
<member name="M:Vanara.PInvoke.NetApi32.NetServerGetInfo(System.String,System.Int32,Vanara.PInvoke.NetApi32.SafeNetApiBuffer@)">
<summary>The NetServerGetInfo function retrieves current configuration information for the specified server.</summary>
<param name="servername">
Pointer to a string that specifies the name of the remote server on which the function is to execute. If this parameter is NULL, the local computer
is used.
</param>
<param name="level">Specifies the information level of the data.</param>
<param name="bufptr">
Pointer to the buffer that receives the data. The format of this data depends on the value of the level parameter. This buffer is allocated by the
system and must be freed using the NetApiBufferFree function.
</param>
<returns>If the function succeeds, the return value is NERR_Success.</returns>
</member>
<member name="T:Vanara.PInvoke.NetApi32.DOMAIN_CONTROLLER_INFO">
<summary>The DOMAIN_CONTROLLER_INFO structure is used with the DsGetDcName function to receive data about a domain controller.</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.DOMAIN_CONTROLLER_INFO.ClientSiteName">
<summary>
Pointer to a null-terminated string that specifies the name of the site that the computer belongs to. The computer is specified in the
ComputerName parameter passed to DsGetDcName. This member may be NULL if the site that contains the computer cannot be found; for example, if the
DS administrator has not associated the subnet that the computer is in with a valid site.
</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.DOMAIN_CONTROLLER_INFO.DcSiteName">
<summary>
Pointer to a null-terminated string that specifies the name of the site where the domain controller is located. This member may be NULL if the
domain controller is not in a site; for example, the domain controller is a Windows NT 4.0 domain controller.
</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.DOMAIN_CONTROLLER_INFO.DnsForestName">
<summary>
Pointer to a null-terminated string that specifies the name of the domain at the root of the DS tree. The DNS-style name, for example,
"fabrikam.com", is returned if available. Otherwise, the flat-style name, for example, "fabrikam" is returned.
</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.DOMAIN_CONTROLLER_INFO.DomainControllerAddress">
<summary>
Pointer to a null-terminated string that specifies the address of the discovered domain controller. The address is prefixed with "\\". This
string is one of the types defined by the DomainControllerAddressType member.
</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.DOMAIN_CONTROLLER_INFO.DomainControllerAddressType">
<summary>Indicates the type of string that is contained in the DomainControllerAddress member.</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.DOMAIN_CONTROLLER_INFO.DomainControllerName">
<summary>
Pointer to a null-terminated string that specifies the computer name of the discovered domain controller. The returned computer name is prefixed
with "\\". The DNS-style name, for example, "\\phoenix.fabrikam.com", is returned, if available. If the DNS-style name is not available, the
flat-style name (for example, "\\phoenix") is returned. This example would apply if the domain is a Windows NT 4.0 domain or if the domain does
not support the IP family of protocols.
</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.DOMAIN_CONTROLLER_INFO.DomainGuid">
<summary>
The GUID of the domain. This member is zero if the domain controller does not have a Domain GUID; for example, the domain controller is not a
Windows 2000 domain controller.
</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.DOMAIN_CONTROLLER_INFO.DomainName">
<summary>
Pointer to a null-terminated string that specifies the name of the domain. The DNS-style name, for example, "fabrikam.com", is returned if
available. Otherwise, the flat-style name, for example, "fabrikam", is returned. This name may be different than the requested domain name if the
domain has been renamed.
</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.DOMAIN_CONTROLLER_INFO.Flags">
<summary>Contains a set of flags that describe the domain controller. This can be zero or a combination of one or more of the following values.</summary>
</member>
<member name="T:Vanara.PInvoke.NetApi32.DomainControllerAddressType">
<summary>Enumeration supporting <see cref="F:Vanara.PInvoke.NetApi32.DOMAIN_CONTROLLER_INFO.DomainControllerAddressType" />.</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.DomainControllerAddressType.DS_INET_ADDRESS">
<summary>The address is a string IP address (for example, "\\157.55.94.74") of the domain controller.</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.DomainControllerAddressType.DS_NETBIOS_ADDRESS">
<summary>The address is a NetBIOS name, for example, "\\phoenix", of the domain controller.</summary>
</member>
<member name="T:Vanara.PInvoke.NetApi32.DomainControllerType">
<summary>Enumeration supporting <see cref="F:Vanara.PInvoke.NetApi32.DOMAIN_CONTROLLER_INFO.Flags" />.</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.DomainControllerType.DS_PDC_FLAG">
<summary>The domain controller is PDC of Domain.</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.DomainControllerType.DS_GC_FLAG">
<summary>The domain controller is a GC of forest.</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.DomainControllerType.DS_LDAP_FLAG">
<summary>Server supports an LDAP server.</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.DomainControllerType.DS_DS_FLAG">
<summary>The domain controller supports a DS and is a Domain Controller.</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.DomainControllerType.DS_KDC_FLAG">
<summary>The domain controller is running KDC service.</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.DomainControllerType.DS_TIMESERV_FLAG">
<summary>The domain controller is running time service.</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.DomainControllerType.DS_CLOSEST_FLAG">
<summary>The domain controller is in closest site to client.</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.DomainControllerType.DS_WRITABLE_FLAG">
<summary>The domain controller has a writable DS.</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.DomainControllerType.DS_GOOD_TIMESERV_FLAG">
<summary>The domain controller is running time service (and has clock hardware).</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.DomainControllerType.DS_NDNC_FLAG">
<summary>DomainName is non-domain NC serviced by the LDAP server.</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.DomainControllerType.DS_SELECT_SECRET_DOMAIN_6_FLAG">
<summary>The domain controller has some secrets.</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.DomainControllerType.DS_FULL_SECRET_DOMAIN_6_FLAG">
<summary>The domain controller has all secrets.</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.DomainControllerType.DS_WS_FLAG">
<summary>The domain controller is running web service.</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.DomainControllerType.DS_DS_8_FLAG">
<summary>The domain controller is running Win8 or later.</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.DomainControllerType.DS_DS_9_FLAG">
<summary>The domain controller is running Win8.1 or later.</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.DomainControllerType.DS_DS_10_FLAG">
<summary>The domain controller is running WinThreshold or later.</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.DomainControllerType.DS_PING_FLAGS">
<summary>Flags returned on ping.</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.DomainControllerType.DS_DNS_CONTROLLER_FLAG">
<summary>The DomainControllerName is a DNS name.</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.DomainControllerType.DS_DNS_DOMAIN_FLAG">
<summary>The DomainName is a DNS name.</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.DomainControllerType.DS_DNS_FOREST_FLAG">
<summary>The DnsForestName is a DNS name.</summary>
</member>
<member name="T:Vanara.PInvoke.NetApi32.DsGetDcNameFlags">
<summary>Flags supporting behavior of <see cref="!:PInvoke.DsGetDcName" />.</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.DsGetDcNameFlags.DS_FORCE_REDISCOVERY">
<summary>
Forces cached domain controller data to be ignored. When the DS_FORCE_REDISCOVERY flag is not specified, DsGetDcName may return cached domain
controller data. If this flag is specified, DsGetDcName will not use cached information (if any exists) but will instead perform a fresh domain
controller discovery.
<para>
This flag should not be used under normal conditions, as using the cached domain controller information has better performance characteristics
and helps to ensure that the same domain controller is used consistently by all applications. This flag should be used only after the application
determines that the domain controller returned by DsGetDcName (when called without this flag) is not accessible. In that case, the application
should repeat the DsGetDcName call with this flag to ensure that the unuseful cached information (if any) is ignored and a reachable domain
controller is discovered.
</para></summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.DsGetDcNameFlags.DS_DIRECTORY_SERVICE_REQUIRED">
<summary>Requires that the returned domain controller support directory services.</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.DsGetDcNameFlags.DS_DIRECTORY_SERVICE_PREFERRED">
<summary>
DsGetDcName attempts to find a domain controller that supports directory service functions. If a domain controller that supports directory
services is not available, DsGetDcName returns the name of a non-directory service domain controller. However, DsGetDcName only returns a
non-directory service domain controller after the attempt to find a directory service domain controller times out.
</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.DsGetDcNameFlags.DS_GC_SERVER_REQUIRED">
<summary>
Requires that the returned domain controller be a global catalog server for the forest of domains with this domain as the root. If this flag is
set and the DomainName parameter is not NULL, DomainName must specify a forest name. This flag cannot be combined with the DS_PDC_REQUIRED or
DS_KDC_REQUIRED flags.
</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.DsGetDcNameFlags.DS_PDC_REQUIRED">
<summary>
Requires that the returned domain controller be the primary domain controller for the domain. This flag cannot be combined with the
DS_KDC_REQUIRED or DS_GC_SERVER_REQUIRED flags.
</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.DsGetDcNameFlags.DS_BACKGROUND_ONLY">
<summary>
If the DS_FORCE_REDISCOVERY flag is not specified, this function uses cached domain controller data. If the cached data is more than 15 minutes
old, the cache is refreshed by pinging the domain controller. If this flag is specified, this refresh is avoided even if the cached data is
expired. This flag should be used if the DsGetDcName function is called periodically.
</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.DsGetDcNameFlags.DS_IP_REQUIRED">
<summary>
This parameter indicates that the domain controller must have an IP address. In that case, DsGetDcName will place the Internet protocol address
of the domain controller in the DomainControllerAddress member of DomainControllerInfo.
</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.DsGetDcNameFlags.DS_KDC_REQUIRED">
<summary>
Requires that the returned domain controller be currently running the Kerberos Key Distribution Center service. This flag cannot be combined with
the DS_PDC_REQUIRED or DS_GC_SERVER_REQUIRED flags.
</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.DsGetDcNameFlags.DS_TIMESERV_REQUIRED">
<summary>Requires that the returned domain controller be currently running the Windows Time Service.</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.DsGetDcNameFlags.DS_WRITABLE_REQUIRED">
<summary>Requires that the returned domain controller be writable; that is, host a writable copy of the directory service.</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.DsGetDcNameFlags.DS_GOOD_TIMESERV_PREFERRED">
<summary>
DsGetDcName attempts to find a domain controller that is a reliable time server. The Windows Time Service can be configured to declare one or
more domain controllers as a reliable time server. For more information, see the Windows Time Service documentation. This flag is intended to be
used only by the Windows Time Service.
</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.DsGetDcNameFlags.DS_AVOID_SELF">
<summary>
When called from a domain controller, specifies that the returned domain controller name should not be the current computer. If the current
computer is not a domain controller, this flag is ignored. This flag can be used to obtain the name of another domain controller in the domain.
</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.DsGetDcNameFlags.DS_ONLY_LDAP_NEEDED">
<summary>
Specifies that the server returned is an LDAP server. The server returned is not necessarily a domain controller. No other services are implied
to be present at the server. The server returned does not necessarily have a writable config container nor a writable schema container. The
server returned may not necessarily be used to create or modify security principles. This flag may be used with the DS_GC_SERVER_REQUIRED flag to
return an LDAP server that also hosts a global catalog server. The returned global catalog server is not necessarily a domain controller. No
other services are implied to be present at the server. If this flag is specified, the DS_PDC_REQUIRED, DS_TIMESERV_REQUIRED,
DS_GOOD_TIMESERV_PREFERRED, DS_DIRECTORY_SERVICES_PREFERED, DS_DIRECTORY_SERVICES_REQUIRED, and DS_KDC_REQUIRED flags are ignored.
</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.DsGetDcNameFlags.DS_IS_FLAT_NAME">
<summary>Specifies that the DomainName parameter is a flat name. This flag cannot be combined with the DS_IS_DNS_NAME flag.</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.DsGetDcNameFlags.DS_IS_DNS_NAME">
<summary>
Specifies that the DomainName parameter is a DNS name. This flag cannot be combined with the DS_IS_FLAT_NAME flag.
<para>
Specify either DS_IS_DNS_NAME or DS_IS_FLAT_NAME. If neither flag is specified, DsGetDcName may take longer to find a domain controller because
it may have to search for both the DNS-style and flat name.
</para></summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.DsGetDcNameFlags.DS_TRY_NEXTCLOSEST_SITE">
<summary>
When this flag is specified, DsGetDcName attempts to find a domain controller in the same site as the caller. If no such domain controller is
found, it will find a domain controller that can provide topology information and call DsBindToISTG to obtain a bind handle, then call
DsQuerySitesByCost over UDP to determine the "next closest site," and finally cache the name of the site found. If no domain controller is found
in that site, then DsGetDcName falls back on the default method of locating a domain controller.
<para>If this flag is used in conjunction with a non-NULL value in the input parameter SiteName, then ERROR_INVALID_FLAGS is thrown.</para><para>
Also, the kind of search employed with DS_TRY_NEXT_CLOSEST_SITE is site-specific, so this flag is ignored if it is used in conjunction with
DS_PDC_REQUIRED. Finally, DS_TRY_NEXTCLOSEST_SITE is ignored when used in conjunction with DS_RETURN_FLAT_NAME because that uses NetBIOS to
resolve the name, but the domain of the domain controller found won't necessarily match the domain to which the client is joined.
</para><note>Note This flag is Group Policy enabled. If you enable the "Next Closest Site" policy setting, Next Closest Site DC Location will be turned
on for the machine across all available but un-configured network adapters. If you disable the policy setting, Next Closest Site DC Location will
not be used by default for the machine across all available but un-configured network adapters. However, if a DC Locator call is made using the
DS_TRY_NEXTCLOSEST_SITE flag explicitly, DsGetDcName honors the Next Closest Site behavior. If you do not configure this policy setting, Next
Closest Site DC Location will be not be used by default for the machine across all available but un-configured network adapters. If the
DS_TRY_NEXTCLOSEST_SITE flag is used explicitly, the Next Closest Site behavior will be used.</note></summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.DsGetDcNameFlags.DS_DIRECTORY_SERVICE_6_REQUIRED">
<summary>Requires that the returned domain controller be running Windows Server 2008 or later.</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.DsGetDcNameFlags.DS_WEB_SERVICE_REQUIRED">
<summary>Requires that the returned domain controller be currently running the Active Directory web service.</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.DsGetDcNameFlags.DS_DIRECTORY_SERVICE_8_REQUIRED">
<summary>Requires that the returned domain controller be running Windows Server 2012 or later.</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.DsGetDcNameFlags.DS_DIRECTORY_SERVICE_9_REQUIRED">
<summary>Requires that the returned domain controller be running Windows Server 2012 R2 or later.</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.DsGetDcNameFlags.DS_DIRECTORY_SERVICE_10_REQUIRED">
<summary>Requires that the returned domain controller be running Windows Server 2016 or later.</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.DsGetDcNameFlags.DS_RETURN_DNS_NAME">
<summary>
Specifies that the names returned in the DomainControllerName and DomainName members of DomainControllerInfo should be DNS names. If a DNS name
is not available, an error is returned. This flag cannot be specified with the DS_RETURN_FLAT_NAME flag. This flag implies the DS_IP_REQUIRED flag.
</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.DsGetDcNameFlags.DS_RETURN_FLAT_NAME">
<summary>
Specifies that the names returned in the DomainControllerName and DomainName members of DomainControllerInfo should be flat names. If a flat name
is not available, an error is returned. This flag cannot be specified with the DS_RETURN_DNS_NAME flag.
</summary>
</member>
<member name="T:Vanara.PInvoke.NetApi32.INetServerInfo">
<summary>Inherit from this interface for any implementation of the SERVER_INFO_XXXX structures to use the helper functions.</summary>
</member>
<member name="T:Vanara.PInvoke.NetApi32.NetServerEnumFilter">
<summary>Filters used by <see cref="M:Vanara.PInvoke.NetApi32.NetServerEnum(System.String,System.Int32,Vanara.PInvoke.NetApi32.SafeNetApiBuffer@,System.Int32,System.Int32@,System.Int32@,Vanara.PInvoke.NetApi32.NetServerEnumFilter,System.String,System.IntPtr)" />.</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.NetServerEnumFilter.SV_TYPE_WORKSTATION">
<summary>All workstations.</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.NetServerEnumFilter.SV_TYPE_SERVER">
<summary>All computers that run the Server service.</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.NetServerEnumFilter.SV_TYPE_SQLSERVER">
<summary>Any server that runs an instance of Microsoft SQL Server.</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.NetServerEnumFilter.SV_TYPE_DOMAIN_CTRL">
<summary>A server that is primary domain controller.</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.NetServerEnumFilter.SV_TYPE_DOMAIN_BAKCTRL">
<summary>Any server that is a backup domain controller.</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.NetServerEnumFilter.SV_TYPE_TIME_SOURCE">
<summary>Any server that runs the Timesource service.</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.NetServerEnumFilter.SV_TYPE_AFP">
<summary>Any server that runs the Apple Filing Protocol (AFP) file service.</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.NetServerEnumFilter.SV_TYPE_NOVELL">
<summary>Any server that is a Novell server.</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.NetServerEnumFilter.SV_TYPE_DOMAIN_MEMBER">
<summary>Any computer that is LAN Manager 2.x domain member.</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.NetServerEnumFilter.SV_TYPE_PRINTQ_SERVER">
<summary>Any computer that shares a print queue.</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.NetServerEnumFilter.SV_TYPE_DIALIN_SERVER">
<summary>Any server that runs a dial-in service.</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.NetServerEnumFilter.SV_TYPE_XENIX_SERVER">
<summary>Any server that is a Xenix server.</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.NetServerEnumFilter.SV_TYPE_SERVER_UNIX">
<summary>Any server that is a UNIX server. This is the same as the SV_TYPE_XENIX_SERVER.</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.NetServerEnumFilter.SV_TYPE_NT">
<summary>A workstation or server.</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.NetServerEnumFilter.SV_TYPE_WFW">
<summary>Any computer that runs Windows for Workgroups.</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.NetServerEnumFilter.SV_TYPE_SERVER_MFPN">
<summary>Any server that runs the Microsoft File and Print for NetWare service.</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.NetServerEnumFilter.SV_TYPE_SERVER_NT">
<summary>Any server that is not a domain controller.</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.NetServerEnumFilter.SV_TYPE_POTENTIAL_BROWSER">
<summary>Any computer that can run the browser service.</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.NetServerEnumFilter.SV_TYPE_BACKUP_BROWSER">
<summary>A computer that runs a browser service as backup.</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.NetServerEnumFilter.SV_TYPE_MASTER_BROWSER">
<summary>A computer that runs the master browser service.</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.NetServerEnumFilter.SV_TYPE_DOMAIN_MASTER">
<summary>A computer that runs the domain master browser.</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.NetServerEnumFilter.SV_TYPE_SERVER_OSF">
<summary>A computer that runs OSF/1.</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.NetServerEnumFilter.SV_TYPE_SERVER_VMS">
<summary>A computer that runs Open Virtual Memory System (VMS).</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.NetServerEnumFilter.SV_TYPE_WINDOWS">
<summary>A computer that runs Windows.</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.NetServerEnumFilter.SV_TYPE_DFS">
<summary>A computer that is the root of Distributed File System (DFS) tree.</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.NetServerEnumFilter.SV_TYPE_CLUSTER_NT">
<summary>Server clusters available in the domain.</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.NetServerEnumFilter.SV_TYPE_TERMINALSERVER">
<summary>A server running the Terminal Server service.</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.NetServerEnumFilter.SV_TYPE_CLUSTER_VS_NT">
<summary>
Cluster virtual servers available in the domain.
<para>Windows 2000: This value is not supported.</para></summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.NetServerEnumFilter.SV_TYPE_DCE">
<summary>A computer that runs IBM Directory and Security Services (DSS) or equivalent.</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.NetServerEnumFilter.SV_TYPE_ALTERNATE_XPORT">
<summary>A computer that over an alternate transport.</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.NetServerEnumFilter.SV_TYPE_LOCAL_LIST_ONLY">
<summary>Any computer maintained in a list by the browser. See the following Remarks section.</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.NetServerEnumFilter.SV_TYPE_DOMAIN_ENUM">
<summary>The primary domain.</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.NetServerEnumFilter.SV_TYPE_ALL">
<summary>All servers. This is a convenience that will return all possible servers.</summary>
</member>
<member name="T:Vanara.PInvoke.NetApi32.SafeNetApiBuffer">
<summary>Provides a <see cref="T:System.Runtime.InteropServices.SafeHandle" /> for buffers that must be freed using <see cref="M:Vanara.PInvoke.NetApi32.NetApiBufferFree(System.IntPtr)" />.</summary>
</member>
<member name="M:Vanara.PInvoke.NetApi32.SafeNetApiBuffer.#ctor">
<summary>Initializes a new instance of the <see cref="T:Vanara.PInvoke.NetApi32.SafeNetApiBuffer" /> class.</summary>
</member>
<member name="M:Vanara.PInvoke.NetApi32.SafeNetApiBuffer.#ctor(System.IntPtr,System.Boolean)">
<summary>Initializes a new instance of the <see cref="T:Vanara.PInvoke.NetApi32.SafeNetApiBuffer" /> class with an existing pointer.</summary>
<param name="ptr">The pointer to the buffer.</param>
<param name="own">if set to <c>true</c> this <see cref="T:System.Runtime.InteropServices.SafeHandle" /> will release the buffer behind the pointer when its scope ends.</param>
</member>
<member name="M:Vanara.PInvoke.NetApi32.SafeNetApiBuffer.ToStructure``1">
<summary>Returns an extracted structure from this buffer.</summary>
<typeparam name="T">The structure type to extract.</typeparam>
<returns>Extracted structure or default(T) if the buffer is invalid.</returns>
</member>
<member name="T:Vanara.PInvoke.NetApi32.SERVER_INFO_100">
<summary>The <c>SERVER_INFO_100</c> structure contains information about the specified server, including the name and platform.</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.SERVER_INFO_100.sv100_name">
<summary>A pointer to a Unicode string that specifies the name of the server.</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.SERVER_INFO_100.sv100_platform_id">
<summary>The information level to use for platform-specific information.</summary>
</member>
<member name="T:Vanara.PInvoke.NetApi32.SERVER_INFO_101">
<summary>
The <c>SERVER_INFO_101</c> structure contains information about the specified server, including name, platform, type of server, and associated software.
</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.SERVER_INFO_101.sv101_comment">
<summary>A pointer to a Unicode string specifying a comment describing the server. The comment can be null.</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.SERVER_INFO_101.sv101_name">
<summary>A pointer to a Unicode string specifying the name of a server.</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.SERVER_INFO_101.sv101_platform_id">
<summary>The information level to use for platform-specific information.</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.SERVER_INFO_101.sv101_type">
<summary>The type of software the computer is running.</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.SERVER_INFO_101.sv101_version_major">
<summary>
The major version number and the server type.
<para>
The major release version number of the operating system is specified in the least significant 4 bits. The server type is specified in the most
significant 4 bits. The <c>MAJOR_VERSION_MASK</c> bitmask defined in the Lmserver.h header should be used by an application to obtain the major
version number from this member.
</para></summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.SERVER_INFO_101.sv101_version_minor">
<summary>The minor release version number of the operating system.</summary>
</member>
<member name="P:Vanara.PInvoke.NetApi32.SERVER_INFO_101.Version">
<summary>Gets the version composed of both <see cref="F:Vanara.PInvoke.NetApi32.SERVER_INFO_101.sv101_version_major" /> and <see cref="F:Vanara.PInvoke.NetApi32.SERVER_INFO_101.sv101_version_minor" />.</summary>
</member>
<member name="T:Vanara.PInvoke.NetApi32.SERVER_INFO_102">
<summary>
The SERVER_INFO_102 structure contains information about the specified server, including name, platform, type of server, attributes, and associated software.
</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.SERVER_INFO_102.sv102_anndelta">
<summary>
The delta value for the announce rate, in milliseconds. This value specifies how much the announce rate can vary from the period of time
specified in the sv102_announce member.
<para>
The delta value allows randomly varied announce rates. For example, if the sv102_announce member has the value 10 and the sv102_anndelta member
has the value 1, the announce rate can vary from 9.999 seconds to 10.001 seconds.
</para></summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.SERVER_INFO_102.sv102_announce">
<summary>The network announce rate, in seconds. This rate determines how often the server is announced to other computers on the network.</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.SERVER_INFO_102.sv102_comment">
<summary>A pointer to a Unicode string specifying a comment describing the server. The comment can be null.</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.SERVER_INFO_102.sv102_disc">
<summary>
The auto-disconnect time, in minutes. A session is disconnected if it is idle longer than the period of time specified by the sv102_disc member.
If the value of sv102_disc is SV_NODISC, auto-disconnect is not enabled.
</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.SERVER_INFO_102.sv102_hidden">
<summary>A value that indicates whether the server is visible to other computers in the same network domain.</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.SERVER_INFO_102.sv102_licenses">
<summary>The number of users per license. By default, this number is SV_USERS_PER_LICENSE.</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.SERVER_INFO_102.sv102_name">
<summary>A pointer to a Unicode string specifying the name of a server.</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.SERVER_INFO_102.sv102_platform_id">
<summary>The information level to use for platform-specific information.</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.SERVER_INFO_102.sv102_type">
<summary>The type of software the computer is running.</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.SERVER_INFO_102.sv102_userpath">
<summary>A pointer to a Unicode string specifying the path to user directories.</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.SERVER_INFO_102.sv102_users">
<summary>
The number of users who can attempt to log on to the system server. Note that it is the license server that determines how many of these users
can actually log on.
</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.SERVER_INFO_102.sv102_version_major">
<summary>
The major version number and the server type.
<para>
The major release version number of the operating system is specified in the least significant 4 bits. The server type is specified in the most
significant 4 bits. The <c>MAJOR_VERSION_MASK</c> bitmask defined in the Lmserver.h header should be used by an application to obtain the major
version number from this member.
</para></summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.SERVER_INFO_102.sv102_version_minor">
<summary>The minor release version number of the operating system.</summary>
</member>
<member name="P:Vanara.PInvoke.NetApi32.SERVER_INFO_102.Version">
<summary>Gets the version composed of both <see cref="F:Vanara.PInvoke.NetApi32.SERVER_INFO_102.sv102_version_major" /> and <see cref="F:Vanara.PInvoke.NetApi32.SERVER_INFO_102.sv102_version_minor" />.</summary>
</member>
<member name="T:Vanara.PInvoke.NetApi32.ServerPlatform">
<summary>The information level to use for platform-specific information.</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.ServerPlatform.PLATFORM_ID_DOS">
<summary>The MS-DOS platform.</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.ServerPlatform.PLATFORM_ID_OS2">
<summary>The OS/2 platform.</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.ServerPlatform.PLATFORM_ID_NT">
<summary>The Windows NT platform.</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.ServerPlatform.PLATFORM_ID_OSF">
<summary>The OSF platform.</summary>
</member>
<member name="F:Vanara.PInvoke.NetApi32.ServerPlatform.PLATFORM_ID_VMS">
<summary>The VMS platform.</summary>
</member>
</members>
</doc>

View File

@ -0,0 +1,550 @@
<?xml version="1.0" encoding="utf-8"?>
<doc>
<assembly>
<name>Vanara.PInvoke.NetListMgr</name>
</assembly>
<members>
<member name="T:Vanara.PInvoke.NetListMgr">
<summary>
<markup>
<include item="SMCMissingTag">
<parameter>summary</parameter>
<parameter>T:Vanara.PInvoke.NetListMgr</parameter>
</include>
</markup>
</summary>
</member>
<member name="T:Vanara.PInvoke.NetListMgr.IEnumNetworkConnections">
<summary>
The IEnumNetworkConnections interface provides a standard enumerator for network connections. It enumerates active, disconnected, or all network
connections within a network. This interface can be obtained from the INetwork interface.
</summary>
</member>
<member name="P:Vanara.PInvoke.NetListMgr.IEnumNetworkConnections._NewEnum">
<summary>
<markup>
<include item="SMCMissingTag">
<parameter>summary</parameter>
<parameter>P:Vanara.PInvoke.NetListMgr.IEnumNetworkConnections._NewEnum</parameter>
</include>
</markup>
</summary>
</member>
<member name="M:Vanara.PInvoke.NetListMgr.IEnumNetworkConnections.Clone">
<summary>The Clone method creates an enumerator that contains the same enumeration state as the enumerator currently in use.</summary>
<returns>Pointer to new IEnumNetworkConnections interface instance.</returns>
</member>
<member name="M:Vanara.PInvoke.NetListMgr.IEnumNetworkConnections.Next(System.UInt32,Vanara.PInvoke.NetListMgr.INetworkConnection@,System.UInt32@)">
<summary>Gets the next specified number of elements in the enumeration sequence.</summary>
<param name="celt">Number of elements requested.</param>
<param name="rgelt">Pointer to a list of pointers returned by INetworkConnection.</param>
<param name="pceltFetched">Pointer to the number of elements supplied. May be NULL if celt is one.</param>
<returns>
<markup>
<include item="SMCMissingTag">
<parameter>returns</parameter>
<parameter>M:Vanara.PInvoke.NetListMgr.IEnumNetworkConnections.Next(System.UInt32,Vanara.PInvoke.NetListMgr.INetworkConnection@,System.UInt32@)</parameter>
</include>
</markup>
</returns>
</member>
<member name="M:Vanara.PInvoke.NetListMgr.IEnumNetworkConnections.Reset">
<summary>The Reset method resets the enumeration sequence to the beginning.</summary>
<returns>
<markup>
<include item="SMCMissingTag">
<parameter>returns</parameter>
<parameter>M:Vanara.PInvoke.NetListMgr.IEnumNetworkConnections.Reset</parameter>
</include>
</markup>
</returns>
</member>
<member name="M:Vanara.PInvoke.NetListMgr.IEnumNetworkConnections.Skip(System.UInt32)">
<summary>The Skip method skips over the next specified number of elements in the enumeration sequence.</summary>
<param name="celt">Number of elements to skip over in the enumeration.</param>
<returns>
<markup>
<include item="SMCMissingTag">
<parameter>returns</parameter>
<parameter>M:Vanara.PInvoke.NetListMgr.IEnumNetworkConnections.Skip(System.UInt32)</parameter>
</include>
</markup>
</returns>
</member>
<member name="T:Vanara.PInvoke.NetListMgr.IEnumNetworks">
<summary>Enumerates all networks available on the server. This interface can be obtained from the INetwork interface.</summary>
</member>
<member name="P:Vanara.PInvoke.NetListMgr.IEnumNetworks._NewEnum">
<summary>
<markup>
<include item="SMCMissingTag">
<parameter>summary</parameter>
<parameter>P:Vanara.PInvoke.NetListMgr.IEnumNetworks._NewEnum</parameter>
</include>
</markup>
</summary>
</member>
<member name="M:Vanara.PInvoke.NetListMgr.IEnumNetworks.Clone">
<summary>The Clone method creates an enumerator that contains the same enumeration state as the enumerator currently in use.</summary>
<returns>Pointer to new IEnumNetworks interface instance.</returns>
</member>
<member name="M:Vanara.PInvoke.NetListMgr.IEnumNetworks.Next(System.UInt32,Vanara.PInvoke.NetListMgr.INetwork@,System.UInt32@)">
<summary>Gets the next specified number of elements in the enumeration sequence.</summary>
<param name="celt">Number of elements requested.</param>
<param name="rgelt">Pointer to a list of pointers returned by INetworkConnection.</param>
<param name="pceltFetched">Pointer to the number of elements supplied. May be NULL if celt is one.</param>
<returns>
<markup>
<include item="SMCMissingTag">
<parameter>returns</parameter>
<parameter>M:Vanara.PInvoke.NetListMgr.IEnumNetworks.Next(System.UInt32,Vanara.PInvoke.NetListMgr.INetwork@,System.UInt32@)</parameter>
</include>
</markup>
</returns>
</member>
<member name="M:Vanara.PInvoke.NetListMgr.IEnumNetworks.Reset">
<summary>The Reset method resets the enumeration sequence to the beginning.</summary>
<returns>
<markup>
<include item="SMCMissingTag">
<parameter>returns</parameter>
<parameter>M:Vanara.PInvoke.NetListMgr.IEnumNetworks.Reset</parameter>
</include>
</markup>
</returns>
</member>
<member name="M:Vanara.PInvoke.NetListMgr.IEnumNetworks.Skip(System.UInt32)">
<summary>The Skip method skips over the next specified number of elements in the enumeration sequence.</summary>
<param name="celt">Number of elements to skip over in the enumeration.</param>
<returns>
<markup>
<include item="SMCMissingTag">
<parameter>returns</parameter>
<parameter>M:Vanara.PInvoke.NetListMgr.IEnumNetworks.Skip(System.UInt32)</parameter>
</include>
</markup>
</returns>
</member>
<member name="T:Vanara.PInvoke.NetListMgr.INetwork">
<summary>
The INetwork interface represents a network on the local machine. It can also represent a collection of network connections with a similar network signature.
</summary>
</member>
<member name="M:Vanara.PInvoke.NetListMgr.INetwork.GetCategory">
<summary>Returns the category of a network.</summary>
<returns>A NLM_NETWORK_CATEGORY enumeration value that specifies the category information for the network.</returns>
</member>
<member name="M:Vanara.PInvoke.NetListMgr.INetwork.GetConnectivity">
<summary>Returns the connectivity state of the network.</summary>
<returns>A NLM_CONNECTIVITY enumeration value that contains a bitmask that specifies the connectivity state of this network.</returns>
</member>
<member name="M:Vanara.PInvoke.NetListMgr.INetwork.GetDescription">
<summary>Returns a description string for the network.</summary>
<returns>A string that specifies the text description of the network. This value must be freed using the SysFreeString API.</returns>
</member>
<member name="M:Vanara.PInvoke.NetListMgr.INetwork.GetDomainType">
<summary>Returns the type of network.</summary>
<returns>An NLM_DOMAIN_TYPE enumeration value that specifies the domain type of the network.</returns>
</member>
<member name="M:Vanara.PInvoke.NetListMgr.INetwork.GetName">
<summary>Returns the name of the network.</summary>
<returns>Pointer to the name of the network.</returns>
</member>
<member name="M:Vanara.PInvoke.NetListMgr.INetwork.GetNetworkConnections">
<summary>
Returns an enumeration of all network connections for a network. A network can have multiple connections to it from different interfaces or
different links from the same interface.
</summary>
<returns>An IEnumNetworkConnections interface instance that enumerates the list of local connections to this network.</returns>
</member>
<member name="M:Vanara.PInvoke.NetListMgr.INetwork.GetNetworkId">
<summary>Returns the unique identifier of a network.</summary>
<returns>Pointer to a GUID that specifies the network ID.</returns>
</member>
<member name="M:Vanara.PInvoke.NetListMgr.INetwork.GetTimeCreatedAndConnected(System.UInt32@,System.UInt32@,System.UInt32@,System.UInt32@)">
<summary>Returns the local date and time when the network was created and connected.</summary>
<param name="pdwLowDateTimeCreated">Pointer to a datetime when the network was created. Specifically, it contains the low DWORD of <see cref="F:System.Runtime.InteropServices.ComTypes.FILETIME.dwLowDateTime" />.</param>
<param name="pdwHighDateTimeCreated">Pointer to a datetime when the network was created. Specifically, it contains the high DWORD of <see cref="F:System.Runtime.InteropServices.ComTypes.FILETIME.dwHighDateTime" />.</param>
<param name="pdwLowDateTimeConnected">
Pointer to a datetime when the network was last connected to. Specifically, it contains the low DWORD of <see cref="F:System.Runtime.InteropServices.ComTypes.FILETIME.dwLowDateTime" />.
</param>
<param name="pdwHighDateTimeConnected">
Pointer to a datetime when the network was last connected to. Specifically, it contains the high DWORD of <see cref="F:System.Runtime.InteropServices.ComTypes.FILETIME.dwHighDateTime" />.
</param>
</member>
<member name="P:Vanara.PInvoke.NetListMgr.INetwork.IsConnected">
<summary>Specifies if the network has any network connectivity.</summary>
</member>
<member name="P:Vanara.PInvoke.NetListMgr.INetwork.IsConnectedToInternet">
<summary>Specifies if the network has internet connectivity.</summary>
</member>
<member name="M:Vanara.PInvoke.NetListMgr.INetwork.SetCategory(Vanara.PInvoke.NetListMgr.NLM_NETWORK_CATEGORY)">
<summary>Sets the category of a network. Administrative privileges are needed for this API call.</summary>
<param name="NewCategory">The new category.</param>
</member>
<member name="M:Vanara.PInvoke.NetListMgr.INetwork.SetDescription(System.String)">
<summary>Sets a new description for the network.</summary>
<param name="szDescription">Zero-terminated string that contains the description of the network.</param>
</member>
<member name="M:Vanara.PInvoke.NetListMgr.INetwork.SetName(System.String)">
<summary>Sets or renames the network. This change occurs immediately.</summary>
<param name="szNetworkNewName">Zero-terminated string that contains the new name of the network.</param>
</member>
<member name="T:Vanara.PInvoke.NetListMgr.INetworkConnection">
<summary>The INetworkConnection interface represents a single network connection.</summary>
</member>
<member name="M:Vanara.PInvoke.NetListMgr.INetworkConnection.GetAdapterId">
<summary>Returns the ID of the network adapter used by this connection. There may multiple connections using the same adapter ID.</summary>
<returns>A GUID that specifies the adapter ID of the TCP/IP interface used by this network connection.</returns>
</member>
<member name="M:Vanara.PInvoke.NetListMgr.INetworkConnection.GetConnectionId">
<summary>Returns the Connection ID associated with this network connection.</summary>
<returns>A GUID that specifies the Connection ID associated with this network connection.</returns>
</member>
<member name="M:Vanara.PInvoke.NetListMgr.INetworkConnection.GetConnectivity">
<summary>Returns the connectivity state of the network.</summary>
<returns>A NLM_CONNECTIVITY enumeration value that contains a bitmask that specifies the connectivity of this network connection.</returns>
</member>
<member name="M:Vanara.PInvoke.NetListMgr.INetworkConnection.GetDomainType">
<summary>Returns the type of network connection.</summary>
<returns>An NLM_DOMAIN_TYPE enumeration value that specifies the domain type of the network.</returns>
</member>
<member name="M:Vanara.PInvoke.NetListMgr.INetworkConnection.GetNetwork">
<summary>Returns the associated network for the connection.</summary>
<returns>An INetwork interface instance that specifies the network associated with the connection.</returns>
</member>
<member name="P:Vanara.PInvoke.NetListMgr.INetworkConnection.IsConnected">
<summary>Specifies if the associated network connection has any network connectivity.</summary>
</member>
<member name="P:Vanara.PInvoke.NetListMgr.INetworkConnection.IsConnectedToInternet">
<summary>Specifies if the associated network connection has internet connectivity.</summary>
</member>
<member name="T:Vanara.PInvoke.NetListMgr.INetworkConnectionCost">
<summary>Use this interface to query current network cost and data plan status associated with a connection.</summary>
</member>
<member name="M:Vanara.PInvoke.NetListMgr.INetworkConnectionCost.GetCost">
<summary>Retrieves the network cost associated with a connection.</summary>
<returns>
A DWORD value that represents the network cost of the connection. The lowest 16 bits represent the cost level and the highest 16 bits represent
the cost flags. Possible values are defined by the <see cref="T:Vanara.PInvoke.NetListMgr.NLM_CONNECTION_COST" /> enumeration.
</returns>
</member>
<member name="M:Vanara.PInvoke.NetListMgr.INetworkConnectionCost.GetDataPlanStatus">
<summary>Gets the data plan status.</summary>
<returns>
An NLM_DATAPLAN_STATUS structure that describes the status of the data plan associated with the connection. The caller supplies the memory of
this structure.
</returns>
</member>
<member name="T:Vanara.PInvoke.NetListMgr.INetworkCostManager">
<summary>
Use this interface to query for machine-wide cost and data plan status information associated with either a connection used for machine-wide Internet
connectivity, or the first-hop of routing to a specific destination on a connection. Additionally, this interface enables applications to specify
destination IP addresses to receive cost or data plan status change notifications for.
</summary>
</member>
<member name="M:Vanara.PInvoke.NetListMgr.INetworkCostManager.GetCost(Vanara.PInvoke.NetListMgr.NLM_CONNECTION_COST@,System.IntPtr)">
<summary>
The GetCost method retrieves the current cost of either a machine-wide internet connection, or the first-hop of routing to a specific destination
on a connection. If destIPaddr is NULL, this method instead returns the cost of the network used for machine-wide Internet connectivity.
</summary>
<param name="pCost">
A DWORD value that indicates the cost of the connection. The lowest 16 bits represent the cost level, and the highest 16 bits represent the
flags. Possible values are defined by the <see cref="T:Vanara.PInvoke.NetListMgr.NLM_CONNECTION_COST" /> enumeration.
</param>
<param name="pDestIPAddr">
An <see cref="T:Vanara.PInvoke.NetListMgr.NLM_SOCKADDR" /> structure containing the destination IPv4/IPv6 address. If NULL, this method will instead return the cost associated with the
preferred connection used for machine Internet connectivity.
</param>
</member>
<member name="M:Vanara.PInvoke.NetListMgr.INetworkCostManager.GetDataPlanStatus(Vanara.PInvoke.NetListMgr.NLM_DATAPLAN_STATUS@,System.IntPtr)">
<summary>
The GetDataPlanStatus retrieves the data plan status for either a machine-wide internet connection , or the first-hop of routing to a specific
destination on a connection. If an IPv4/IPv6 address is not specified, this method returns the data plan status of the connection used for
machine-wide Internet connectivity.
</summary>
<param name="pDataPlanStatus">
Pointer to an NLM_DATAPLAN_STATUS structure that describes the data plan status associated with a connection used to route to a destination. If
destIPAddr specifies a tunnel address, the first available data plan status in the interface stack is returned.
</param>
<param name="pDestIPAddr">
An <see cref="T:Vanara.PInvoke.NetListMgr.NLM_SOCKADDR" /> structure containing the destination IPv4/IPv6 or tunnel address. If NULL, this method returns the cost associated with the
preferred connection used for machine Internet connectivity.
</param>
</member>
<member name="M:Vanara.PInvoke.NetListMgr.INetworkCostManager.SetDestinationAddresses(System.UInt32,System.IntPtr,System.Boolean)">
<summary>
The SetDestinationAddresses method registers specified destination IPv4/IPv6 addresses to receive cost or data plan status change notifications.
</summary>
<param name="length">The number of destination IPv4/IPv6 addresses in the list.</param>
<param name="pDestIPAddrList">
A <see cref="T:Vanara.PInvoke.NetListMgr.NLM_SOCKADDR" /> structure containing a list of destination IPv4/IPv6 addresses to register for cost or data plan status change notification.
</param>
<param name="bAppend">If true, pDestIPAddrList will be appended to the existing address list; otherwise the existing list will be overwritten.</param>
</member>
<member name="T:Vanara.PInvoke.NetListMgr.INetworkListManager">
<summary>The INetworkListManager interface provides a set of methods to perform network list management functions.</summary>
</member>
<member name="M:Vanara.PInvoke.NetListMgr.INetworkListManager.ClearSimulatedProfileInfo">
<summary>
Clears the connection profile values previously applied to the internet connection profile by SetSimulatedProfileInfo. The next internet
connection query, via GetInternetConnectionProfile, will use system information.
</summary>
</member>
<member name="M:Vanara.PInvoke.NetListMgr.INetworkListManager.GetConnectivity">
<summary>Returns the connectivity state of all the networks on a machine.</summary>
<returns>An NLM_CONNECTIVITY enumeration value that contains a bitmask that specifies the network connectivity of this machine.</returns>
</member>
<member name="M:Vanara.PInvoke.NetListMgr.INetworkListManager.GetNetwork(System.Guid)">
<summary>Retrieves a network based on a supplied Network ID.</summary>
<param name="gdNetworkId">GUID that specifies the network ID.</param>
<returns>The INetwork interface instance for this network.</returns>
</member>
<member name="M:Vanara.PInvoke.NetListMgr.INetworkListManager.GetNetworkConnection(System.Guid)">
<summary>Retrieves a network based on a supplied Network Connection ID.</summary>
<param name="gdNetworkConnectionId">A GUID that specifies the Network Connection ID.</param>
<returns>A INetworkConnection object associated with the supplied gdNetworkConnectionId.</returns>
</member>
<member name="M:Vanara.PInvoke.NetListMgr.INetworkListManager.GetNetworkConnections">
<summary>Gets an enumerator that contains a complete list of the network connections that have been made.</summary>
<returns>An IEnumNetworkConnections interface instance that enumerates all network connections on the machine.</returns>
</member>
<member name="M:Vanara.PInvoke.NetListMgr.INetworkListManager.GetNetworks(Vanara.PInvoke.NetListMgr.NLM_ENUM_NETWORK)">
<summary>Retrieves networks based on the supplied Network IDs.</summary>
<param name="Flags">NLM_ENUM_NETWORK enumeration value that specifies the flags for the network (specifically, connected or not connected).</param>
<returns>An IEnumNetworks interface instance that contains the enumerator for the list of available networks.</returns>
</member>
<member name="P:Vanara.PInvoke.NetListMgr.INetworkListManager.IsConnected">
<summary>Specifies if the local machine has network connectivity.</summary>
</member>
<member name="P:Vanara.PInvoke.NetListMgr.INetworkListManager.IsConnectedToInternet">
<summary>Specifies if the machine has Internet connectivity.</summary>
</member>
<member name="M:Vanara.PInvoke.NetListMgr.INetworkListManager.SetSimulatedProfileInfo(Vanara.PInvoke.NetListMgr.NLM_SIMULATED_PROFILE_INFO@)">
<summary>
Applies a specific set of connection profile values to the internet connection profile in support of the simulation of specific metered internet
connection conditions.
<para>
The simulation only applies in an RDP Child Session and does not affect the primary user session. The simulated internet connection profile is
returned via the Windows Runtime API GetInternetConnectionProfile.
</para></summary>
<param name="pSimulatedInfo">
Specific connection profile values to simulate on the current internet connection profile when calling GetInternetConnectionProfile from an RDP
Child Session
</param>
</member>
<member name="T:Vanara.PInvoke.NetListMgr.NetworkListManager">
<summary>Provides a set of methods to perform network list management functions.</summary>
</member>
<member name="M:Vanara.PInvoke.NetListMgr.NetworkListManager.#ctor">
<summary>
<markup>
<include item="SMCAutoDocConstructor">
<parameter>Vanara.PInvoke.NetListMgr.NetworkListManager</parameter>
</include>
</markup>
</summary>
</member>
<member name="T:Vanara.PInvoke.NetListMgr.NLM_CONNECTION_COST">
<summary>The <see cref="T:Vanara.PInvoke.NetListMgr.NLM_CONNECTION_COST" /> enumeration specifies a set of cost levels and cost flags supported in Windows 8 Cost APIs.</summary>
</member>
<member name="F:Vanara.PInvoke.NetListMgr.NLM_CONNECTION_COST.NLM_CONNECTION_COST_UNKNOWN">
<summary>The cost is unknown.</summary>
</member>
<member name="F:Vanara.PInvoke.NetListMgr.NLM_CONNECTION_COST.NLM_CONNECTION_COST_UNRESTRICTED">
<summary>The connection is unlimited and is considered to be unrestricted of usage charges and capacity constraints.</summary>
</member>
<member name="F:Vanara.PInvoke.NetListMgr.NLM_CONNECTION_COST.NLM_CONNECTION_COST_FIXED">
<summary>The use of this connection is unrestricted up to a specific data transfer limit.</summary>
</member>
<member name="F:Vanara.PInvoke.NetListMgr.NLM_CONNECTION_COST.NLM_CONNECTION_COST_VARIABLE">
<summary>This connection is regulated on a per byte basis.</summary>
</member>
<member name="F:Vanara.PInvoke.NetListMgr.NLM_CONNECTION_COST.NLM_CONNECTION_COST_OVERDATALIMIT">
<summary>The connection is currently in an OverDataLimit state as it has exceeded the carrier specified data transfer limit.</summary>
</member>
<member name="F:Vanara.PInvoke.NetListMgr.NLM_CONNECTION_COST.NLM_CONNECTION_COST_CONGESTED">
<summary>The network is experiencing high traffic load and is congested.</summary>
</member>
<member name="F:Vanara.PInvoke.NetListMgr.NLM_CONNECTION_COST.NLM_CONNECTION_COST_ROAMING">
<summary>The connection is roaming outside the network and affiliates of the home provider.</summary>
</member>
<member name="F:Vanara.PInvoke.NetListMgr.NLM_CONNECTION_COST.NLM_CONNECTION_COST_APPROACHINGDATALIMIT">
<summary>The connection is approaching the data limit specified by the carrier.</summary>
</member>
<member name="T:Vanara.PInvoke.NetListMgr.NLM_CONNECTION_PROPERTY_CHANGE">
<summary>The NLM_CONNECTION PROPERTY_CHANGE enumeration is a set of flags that define changes made to the properties of a network connection.</summary>
</member>
<member name="F:Vanara.PInvoke.NetListMgr.NLM_CONNECTION_PROPERTY_CHANGE.NLM_CONNECTION_PROPERTY_CHANGE_AUTHENTICATION">
<summary>The Authentication (Domain Type) of this Network Connection has changed.</summary>
</member>
<member name="T:Vanara.PInvoke.NetListMgr.NLM_CONNECTIVITY">
<summary>The NLM_Connectivity enumeration is a set of flags that provide notification whenever connectivity related parameters have changed.</summary>
</member>
<member name="F:Vanara.PInvoke.NetListMgr.NLM_CONNECTIVITY.NLM_CONNECTIVITY_DISCONNECTED">
<summary>The underlying network interfaces have no connectivity to any network.</summary>
</member>
<member name="F:Vanara.PInvoke.NetListMgr.NLM_CONNECTIVITY.NLM_CONNECTIVITY_IPV4_NOTRAFFIC">
<summary>There is connectivity to a network, but the service cannot detect any IPv4 Network Traffic.</summary>
</member>
<member name="F:Vanara.PInvoke.NetListMgr.NLM_CONNECTIVITY.NLM_CONNECTIVITY_IPV6_NOTRAFFIC">
<summary>There is connectivity to a network, but the service cannot detect any IPv6 Network Traffic.</summary>
</member>
<member name="F:Vanara.PInvoke.NetListMgr.NLM_CONNECTIVITY.NLM_CONNECTIVITY_IPV4_SUBNET">
<summary>There is connectivity to the local subnet using the IPv4 protocol.</summary>
</member>
<member name="F:Vanara.PInvoke.NetListMgr.NLM_CONNECTIVITY.NLM_CONNECTIVITY_IPV4_LOCALNETWORK">
<summary>There is connectivity to a routed network using the IPv4 protocol.</summary>
</member>
<member name="F:Vanara.PInvoke.NetListMgr.NLM_CONNECTIVITY.NLM_CONNECTIVITY_IPV4_INTERNET">
<summary>There is connectivity to the Internet using the IPv4 protocol.</summary>
</member>
<member name="F:Vanara.PInvoke.NetListMgr.NLM_CONNECTIVITY.NLM_CONNECTIVITY_IPV6_SUBNET">
<summary>There is connectivity to the local subnet using the IPv6 protocol.</summary>
</member>
<member name="F:Vanara.PInvoke.NetListMgr.NLM_CONNECTIVITY.NLM_CONNECTIVITY_IPV6_LOCALNETWORK">
<summary>There is connectivity to a local network using the IPv6 protocol.</summary>
</member>
<member name="F:Vanara.PInvoke.NetListMgr.NLM_CONNECTIVITY.NLM_CONNECTIVITY_IPV6_INTERNET">
<summary>There is connectivity to the Internet using the IPv6 protocol.</summary>
</member>
<member name="T:Vanara.PInvoke.NetListMgr.NLM_DATAPLAN_STATUS">
<summary>The NLM_DATAPLAN_STATUS structure stores the current data plan status information supplied by the carrier.</summary>
</member>
<member name="F:Vanara.PInvoke.NetListMgr.NLM_DATAPLAN_STATUS.DataLimitInMegabytes">
<summary>
The data plan usage limit expressed in megabytes. If this value is not supplied, a default value of NLM_UNKNOWN_DATAPLAN_STATUS is set.
</summary>
</member>
<member name="F:Vanara.PInvoke.NetListMgr.NLM_DATAPLAN_STATUS.InboundBandwidthInKbps">
<summary>
The maximum inbound connection bandwidth expressed in kbps. If this value is not supplied, a default value of NLM_UNKNOWN_DATAPLAN_STATUS is set.
</summary>
</member>
<member name="F:Vanara.PInvoke.NetListMgr.NLM_DATAPLAN_STATUS.InterfaceGuid">
<summary>
The unique ID of the interface associated with the data plan. This GUID is determined by the system when a data plan is first used by a system connection.
</summary>
</member>
<member name="P:Vanara.PInvoke.NetListMgr.NLM_DATAPLAN_STATUS.IsDefined">
<summary>Gets a value indicating whether the data plan status values are default values, or provided by the MNO.</summary>
</member>
<member name="F:Vanara.PInvoke.NetListMgr.NLM_DATAPLAN_STATUS.MaxTransferSizeInMegabytes">
<summary>
The maximum suggested transfer size for this network expressed in megabytes. If this value is not supplied, a default value of
NLM_UNKNOWN_DATAPLAN_STATUS is set.
</summary>
</member>
<member name="F:Vanara.PInvoke.NetListMgr.NLM_DATAPLAN_STATUS.NextBillingCycle">
<summary>The start time of the next billing cycle. If this value is not supplied, a default value of '0' is set.</summary>
</member>
<member name="F:Vanara.PInvoke.NetListMgr.NLM_DATAPLAN_STATUS.OutboundBandwidthInKbps">
<summary>
The maximum outbound connection bandwidth expressed in kbps. If this value is not supplied, a default value of NLM_UNKNOWN_DATAPLAN_STATUS is set.
</summary>
</member>
<member name="F:Vanara.PInvoke.NetListMgr.NLM_DATAPLAN_STATUS.Reserved">
<summary>Reserved for future use.</summary>
</member>
<member name="F:Vanara.PInvoke.NetListMgr.NLM_DATAPLAN_STATUS.UsageData">
<summary>
An NLM_USAGE_DATA structure containing current data usage value expressed in megabytes, as well as the system time at the moment this value was
last synced.
<para>
If this value is not supplied, NLM_USAGE_DATA will indicate NLM_UNKNOWN_DATAPLAN_STATUS for UsageInMegabytes and a value of '0' will be set for LastSyncTime.
</para></summary>
</member>
<member name="T:Vanara.PInvoke.NetListMgr.NLM_DOMAIN_TYPE">
<summary>The NLM_DOMAIN_TYPE enumeration is a set of flags that specify the domain type of a network.</summary>
</member>
<member name="F:Vanara.PInvoke.NetListMgr.NLM_DOMAIN_TYPE.NLM_DOMAIN_TYPE_NON_DOMAIN_NETWORK">
<summary>The Network is not an Active Directory Network.</summary>
</member>
<member name="F:Vanara.PInvoke.NetListMgr.NLM_DOMAIN_TYPE.NLM_DOMAIN_TYPE_DOMAIN_NETWORK">
<summary>The Network is an Active Directory Network, but this machine is not authenticated against it.</summary>
</member>
<member name="F:Vanara.PInvoke.NetListMgr.NLM_DOMAIN_TYPE.NLM_DOMAIN_TYPE_DOMAIN_AUTHENTICATED">
<summary>The Network is an Active Directory Network, and this machine is authenticated against it.</summary>
</member>
<member name="T:Vanara.PInvoke.NetListMgr.NLM_ENUM_NETWORK">
<summary>The NLM_ENUM_NETWORK enumeration contains a set of flags that specify what types of networks are enumerated.</summary>
</member>
<member name="F:Vanara.PInvoke.NetListMgr.NLM_ENUM_NETWORK.NLM_ENUM_NETWORK_CONNECTED">
<summary>Returns connected networks</summary>
</member>
<member name="F:Vanara.PInvoke.NetListMgr.NLM_ENUM_NETWORK.NLM_ENUM_NETWORK_DISCONNECTED">
<summary>Returns disconnected networks</summary>
</member>
<member name="F:Vanara.PInvoke.NetListMgr.NLM_ENUM_NETWORK.NLM_ENUM_NETWORK_ALL">
<summary>Returns connected and disconnected networks</summary>
</member>
<member name="T:Vanara.PInvoke.NetListMgr.NLM_NETWORK_CATEGORY">
<summary>The NLM_NETWORK_CATEGORY enumeration is a set of flags that specify the category type of a network.</summary>
</member>
<member name="F:Vanara.PInvoke.NetListMgr.NLM_NETWORK_CATEGORY.NLM_NETWORK_CATEGORY_PUBLIC">
<summary>The network is a public (untrusted) network.</summary>
</member>
<member name="F:Vanara.PInvoke.NetListMgr.NLM_NETWORK_CATEGORY.NLM_NETWORK_CATEGORY_PRIVATE">
<summary>The network is a private (trusted) network.</summary>
</member>
<member name="F:Vanara.PInvoke.NetListMgr.NLM_NETWORK_CATEGORY.NLM_NETWORK_CATEGORY_DOMAIN_AUTHENTICATED">
<summary>The network is authenticated against an Active Directory domain.</summary>
</member>
<member name="T:Vanara.PInvoke.NetListMgr.NLM_NETWORK_PROPERTY_CHANGE">
<summary>The NLM_NETWORK_PROPERTY_CHANGE enumeration is a set of flags that define changes made to the properties of a network.</summary>
</member>
<member name="F:Vanara.PInvoke.NetListMgr.NLM_NETWORK_PROPERTY_CHANGE.NLM_NETWORK_PROPERTY_CHANGE_CATEGORY_VALUE">
<summary>The category of the network has changed.</summary>
</member>
<member name="F:Vanara.PInvoke.NetListMgr.NLM_NETWORK_PROPERTY_CHANGE.NLM_NETWORK_PROPERTY_CHANGE_CONNECTION">
<summary>A connection to this network has been added or removed.</summary>
</member>
<member name="F:Vanara.PInvoke.NetListMgr.NLM_NETWORK_PROPERTY_CHANGE.NLM_NETWORK_PROPERTY_CHANGE_DESCRIPTION">
<summary>The description of the network has changed.</summary>
</member>
<member name="F:Vanara.PInvoke.NetListMgr.NLM_NETWORK_PROPERTY_CHANGE.NLM_NETWORK_PROPERTY_CHANGE_ICON">
<summary>The icon of the network has changed.</summary>
</member>
<member name="F:Vanara.PInvoke.NetListMgr.NLM_NETWORK_PROPERTY_CHANGE.NLM_NETWORK_PROPERTY_CHANGE_NAME">
<summary>The name of the network has changed.</summary>
</member>
<member name="T:Vanara.PInvoke.NetListMgr.NLM_SIMULATED_PROFILE_INFO">
<summary>
Used to specify values that are used by SetSimulatedProfileInfo to override current internet connection profile values in an RDP Child Session to
support the simulation of specific metered internet connection conditions.
</summary>
</member>
<member name="F:Vanara.PInvoke.NetListMgr.NLM_SIMULATED_PROFILE_INFO.cost">
<summary>The network cost.</summary>
</member>
<member name="F:Vanara.PInvoke.NetListMgr.NLM_SIMULATED_PROFILE_INFO.DataLimitInMegabytes">
<summary>The data limit of the plan.</summary>
</member>
<member name="F:Vanara.PInvoke.NetListMgr.NLM_SIMULATED_PROFILE_INFO.ProfileName">
<summary>Name for the simulated profile.</summary>
</member>
<member name="F:Vanara.PInvoke.NetListMgr.NLM_SIMULATED_PROFILE_INFO.UsageInMegabytes">
<summary>The data usage.</summary>
</member>
<member name="T:Vanara.PInvoke.NetListMgr.NLM_SOCKADDR">
<summary>The <see cref="T:Vanara.PInvoke.NetListMgr.NLM_SOCKADDR" /> structure contains the IPv4/IPv6 destination address.</summary>
</member>
<member name="F:Vanara.PInvoke.NetListMgr.NLM_SOCKADDR.data">
<summary>An IPv4/IPv6 destination address.</summary>
</member>
<member name="M:Vanara.PInvoke.NetListMgr.NLM_SOCKADDR.FromIPAddress(System.Net.IPAddress)">
<summary>Creates a <see cref="T:Vanara.PInvoke.NetListMgr.NLM_SOCKADDR" /> from an <see cref="T:System.Net.IPAddress" /> instance.</summary>
<param name="address">The IP address to encapsulate.</param>
<returns>A <see cref="T:Vanara.PInvoke.NetListMgr.NLM_SOCKADDR" /> instance with its data field set to either the IPv4 or IPv6 address supplied by <paramref name="address" />.</returns>
</member>
<member name="T:Vanara.PInvoke.NetListMgr.NLM_USAGE_DATA">
<summary>The NLM_USAGE_DATA structure stores information that indicates the data usage of a plan.</summary>
</member>
<member name="F:Vanara.PInvoke.NetListMgr.NLM_USAGE_DATA.LastSyncTime">
<summary>The timestamp of last time synced with carriers about the data usage stored in this structure.</summary>
</member>
<member name="F:Vanara.PInvoke.NetListMgr.NLM_USAGE_DATA.UsageInMegabytes">
<summary>The data usage of a plan, represented in megabytes.</summary>
</member>
</members>
</doc>

9698
docs/Vanara.PInvoke.Ole.xml Normal file

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

25330
docs/Vanara.PInvoke.Shared.xml Normal file

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

View File

@ -0,0 +1,28 @@
<?xml version="1.0" encoding="utf-8"?>
<doc>
<assembly>
<name>Vanara.PInvoke.ShlwApi</name>
</assembly>
<members>
<member name="T:Vanara.PInvoke.ShlwApi">
<summary>
<markup>
<include item="SMCMissingTag">
<parameter>summary</parameter>
<parameter>T:Vanara.PInvoke.ShlwApi</parameter>
</include>
</markup>
</summary>
</member>
<member name="M:Vanara.PInvoke.ShlwApi.SHCreateStreamOnFileEx(System.String,Vanara.PInvoke.STGM,Vanara.PInvoke.FileFlagsAndAttributes,System.Boolean,System.Runtime.InteropServices.ComTypes.IStream,System.Runtime.InteropServices.ComTypes.IStream@)">
<summary>Opens or creates a file and retrieves a stream to read or write to that file.</summary>
<param name="pszFile">A pointer to a null-terminated string that specifies the file name.</param>
<param name="grfMode">One or more STGM values that are used to specify the file access mode and how the object that exposes the stream is created and deleted.</param>
<param name="dwAttributes">One or more flag values that specify file attributes in the case that a new file is created. For a complete list of possible values, see the dwFlagsAndAttributes parameter of the CreateFile function.</param>
<param name="fCreate">A BOOL value that helps specify, in conjunction with grfMode, how existing files should be treated when creating the stream. See Remarks for details.</param>
<param name="pstmTemplate">Reserved.</param>
<param name="ppstm">Receives an IStream interface pointer for the stream associated with the file.</param>
<returns>If this function succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.</returns>
</member>
</members>
</doc>

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

1799
docs/Vanara.Security.xml Normal file

File diff suppressed because it is too large Load Diff

View File

@ -0,0 +1,854 @@
<?xml version="1.0" encoding="utf-8"?>
<doc>
<assembly>
<name>Vanara.SystemServices</name>
</assembly>
<members>
<member name="T:Vanara.Extensions.FileInfoExtension">
<summary>
<markup>
<include item="SMCMissingTag">
<parameter>summary</parameter>
<parameter>T:Vanara.Extensions.FileInfoExtension</parameter>
</include>
</markup>
</summary>
</member>
<member name="M:Vanara.Extensions.FileInfoExtension.GetFileHandle(System.IO.FileSystemInfo,System.Boolean,System.Boolean)">
<summary>
<markup>
<include item="SMCMissingTag">
<parameter>summary</parameter>
<parameter>M:Vanara.Extensions.FileInfoExtension.GetFileHandle(System.IO.FileSystemInfo,System.Boolean,System.Boolean)</parameter>
</include>
</markup>
</summary>
<param name="fi">
<markup>
<include item="SMCMissingParamTag">
<parameter>param</parameter>
<parameter>fi</parameter>
<parameter>M:Vanara.Extensions.FileInfoExtension.GetFileHandle(System.IO.FileSystemInfo,System.Boolean,System.Boolean)</parameter>
</include>
</markup>
</param>
<param name="readOnly">
<markup>
<include item="SMCMissingParamTag">
<parameter>param</parameter>
<parameter>readOnly</parameter>
<parameter>M:Vanara.Extensions.FileInfoExtension.GetFileHandle(System.IO.FileSystemInfo,System.Boolean,System.Boolean)</parameter>
</include>
</markup>
</param>
<param name="overlapped">
<markup>
<include item="SMCMissingParamTag">
<parameter>param</parameter>
<parameter>overlapped</parameter>
<parameter>M:Vanara.Extensions.FileInfoExtension.GetFileHandle(System.IO.FileSystemInfo,System.Boolean,System.Boolean)</parameter>
</include>
</markup>
</param>
<returns>
<markup>
<include item="SMCMissingTag">
<parameter>returns</parameter>
<parameter>M:Vanara.Extensions.FileInfoExtension.GetFileHandle(System.IO.FileSystemInfo,System.Boolean,System.Boolean)</parameter>
</include>
</markup>
</returns>
</member>
<member name="M:Vanara.Extensions.FileInfoExtension.GetFileSystemFlags(System.IO.DriveInfo)">
<summary>
<markup>
<include item="SMCMissingTag">
<parameter>summary</parameter>
<parameter>M:Vanara.Extensions.FileInfoExtension.GetFileSystemFlags(System.IO.DriveInfo)</parameter>
</include>
</markup>
</summary>
<param name="di">
<markup>
<include item="SMCMissingParamTag">
<parameter>param</parameter>
<parameter>di</parameter>
<parameter>M:Vanara.Extensions.FileInfoExtension.GetFileSystemFlags(System.IO.DriveInfo)</parameter>
</include>
</markup>
</param>
<returns>
<markup>
<include item="SMCMissingTag">
<parameter>returns</parameter>
<parameter>M:Vanara.Extensions.FileInfoExtension.GetFileSystemFlags(System.IO.DriveInfo)</parameter>
</include>
</markup>
</returns>
</member>
<member name="M:Vanara.Extensions.FileInfoExtension.GetMaxFileNameLength(System.IO.DriveInfo)">
<summary>
<markup>
<include item="SMCMissingTag">
<parameter>summary</parameter>
<parameter>M:Vanara.Extensions.FileInfoExtension.GetMaxFileNameLength(System.IO.DriveInfo)</parameter>
</include>
</markup>
</summary>
<param name="di">
<markup>
<include item="SMCMissingParamTag">
<parameter>param</parameter>
<parameter>di</parameter>
<parameter>M:Vanara.Extensions.FileInfoExtension.GetMaxFileNameLength(System.IO.DriveInfo)</parameter>
</include>
</markup>
</param>
<returns>
<markup>
<include item="SMCMissingTag">
<parameter>returns</parameter>
<parameter>M:Vanara.Extensions.FileInfoExtension.GetMaxFileNameLength(System.IO.DriveInfo)</parameter>
</include>
</markup>
</returns>
</member>
<member name="M:Vanara.Extensions.FileInfoExtension.GetNtfsCompression(System.IO.FileSystemInfo)">
<summary>
<markup>
<include item="SMCMissingTag">
<parameter>summary</parameter>
<parameter>M:Vanara.Extensions.FileInfoExtension.GetNtfsCompression(System.IO.FileSystemInfo)</parameter>
</include>
</markup>
</summary>
<param name="fi">
<markup>
<include item="SMCMissingParamTag">
<parameter>param</parameter>
<parameter>fi</parameter>
<parameter>M:Vanara.Extensions.FileInfoExtension.GetNtfsCompression(System.IO.FileSystemInfo)</parameter>
</include>
</markup>
</param>
<returns>
<markup>
<include item="SMCMissingTag">
<parameter>returns</parameter>
<parameter>M:Vanara.Extensions.FileInfoExtension.GetNtfsCompression(System.IO.FileSystemInfo)</parameter>
</include>
</markup>
</returns>
</member>
<member name="M:Vanara.Extensions.FileInfoExtension.GetNtfsCompressionAsync(System.IO.FileSystemInfo)">
<summary>
<markup>
<include item="SMCMissingTag">
<parameter>summary</parameter>
<parameter>M:Vanara.Extensions.FileInfoExtension.GetNtfsCompressionAsync(System.IO.FileSystemInfo)</parameter>
</include>
</markup>
</summary>
<param name="fi">
<markup>
<include item="SMCMissingParamTag">
<parameter>param</parameter>
<parameter>fi</parameter>
<parameter>M:Vanara.Extensions.FileInfoExtension.GetNtfsCompressionAsync(System.IO.FileSystemInfo)</parameter>
</include>
</markup>
</param>
<returns>
<markup>
<include item="SMCMissingTag">
<parameter>returns</parameter>
<parameter>M:Vanara.Extensions.FileInfoExtension.GetNtfsCompressionAsync(System.IO.FileSystemInfo)</parameter>
</include>
</markup>
</returns>
</member>
<member name="M:Vanara.Extensions.FileInfoExtension.GetPhysicalLength(System.IO.FileInfo)">
<summary>
Gets the length of the file on the disk. If the file is compressed, this will return the compressed size.
</summary>
<param name="fi">The <see cref="T:System.IO.FileInfo" /> instance.</param>
<returns>The actual size of the file on the disk in bytes, compressed or uncompressed.</returns>
</member>
<member name="M:Vanara.Extensions.FileInfoExtension.SetNtfsCompression(System.IO.FileSystemInfo,System.Boolean)">
<summary>
<markup>
<include item="SMCMissingTag">
<parameter>summary</parameter>
<parameter>M:Vanara.Extensions.FileInfoExtension.SetNtfsCompression(System.IO.FileSystemInfo,System.Boolean)</parameter>
</include>
</markup>
</summary>
<param name="fi">
<markup>
<include item="SMCMissingParamTag">
<parameter>param</parameter>
<parameter>fi</parameter>
<parameter>M:Vanara.Extensions.FileInfoExtension.SetNtfsCompression(System.IO.FileSystemInfo,System.Boolean)</parameter>
</include>
</markup>
</param>
<param name="compressed">
<markup>
<include item="SMCMissingParamTag">
<parameter>param</parameter>
<parameter>compressed</parameter>
<parameter>M:Vanara.Extensions.FileInfoExtension.SetNtfsCompression(System.IO.FileSystemInfo,System.Boolean)</parameter>
</include>
</markup>
</param>
</member>
<member name="M:Vanara.Extensions.FileInfoExtension.SetNtfsCompressionAsync(System.IO.FileSystemInfo,System.Boolean)">
<summary>
<markup>
<include item="SMCMissingTag">
<parameter>summary</parameter>
<parameter>M:Vanara.Extensions.FileInfoExtension.SetNtfsCompressionAsync(System.IO.FileSystemInfo,System.Boolean)</parameter>
</include>
</markup>
</summary>
<param name="fi">
<markup>
<include item="SMCMissingParamTag">
<parameter>param</parameter>
<parameter>fi</parameter>
<parameter>M:Vanara.Extensions.FileInfoExtension.SetNtfsCompressionAsync(System.IO.FileSystemInfo,System.Boolean)</parameter>
</include>
</markup>
</param>
<param name="compressed">
<markup>
<include item="SMCMissingParamTag">
<parameter>param</parameter>
<parameter>compressed</parameter>
<parameter>M:Vanara.Extensions.FileInfoExtension.SetNtfsCompressionAsync(System.IO.FileSystemInfo,System.Boolean)</parameter>
</include>
</markup>
</param>
<returns>
<markup>
<include item="SMCMissingTag">
<parameter>returns</parameter>
<parameter>M:Vanara.Extensions.FileInfoExtension.SetNtfsCompressionAsync(System.IO.FileSystemInfo,System.Boolean)</parameter>
</include>
</markup>
</returns>
</member>
<member name="T:Vanara.Extensions.ProcessExtension">
<summary>
<markup>
<include item="SMCMissingTag">
<parameter>summary</parameter>
<parameter>T:Vanara.Extensions.ProcessExtension</parameter>
</include>
</markup>
</summary>
</member>
<member name="M:Vanara.Extensions.ProcessExtension.DisablePrivilege(System.Diagnostics.Process,Vanara.Security.AccessControl.SystemPrivilege)">
<summary>
<markup>
<include item="SMCMissingTag">
<parameter>summary</parameter>
<parameter>M:Vanara.Extensions.ProcessExtension.DisablePrivilege(System.Diagnostics.Process,Vanara.Security.AccessControl.SystemPrivilege)</parameter>
</include>
</markup>
</summary>
<param name="process">
<markup>
<include item="SMCMissingParamTag">
<parameter>param</parameter>
<parameter>process</parameter>
<parameter>M:Vanara.Extensions.ProcessExtension.DisablePrivilege(System.Diagnostics.Process,Vanara.Security.AccessControl.SystemPrivilege)</parameter>
</include>
</markup>
</param>
<param name="privilege">
<markup>
<include item="SMCMissingParamTag">
<parameter>param</parameter>
<parameter>privilege</parameter>
<parameter>M:Vanara.Extensions.ProcessExtension.DisablePrivilege(System.Diagnostics.Process,Vanara.Security.AccessControl.SystemPrivilege)</parameter>
</include>
</markup>
</param>
</member>
<member name="M:Vanara.Extensions.ProcessExtension.EnablePrivilege(System.Diagnostics.Process,Vanara.Security.AccessControl.SystemPrivilege)">
<summary>
<markup>
<include item="SMCMissingTag">
<parameter>summary</parameter>
<parameter>M:Vanara.Extensions.ProcessExtension.EnablePrivilege(System.Diagnostics.Process,Vanara.Security.AccessControl.SystemPrivilege)</parameter>
</include>
</markup>
</summary>
<param name="process">
<markup>
<include item="SMCMissingParamTag">
<parameter>param</parameter>
<parameter>process</parameter>
<parameter>M:Vanara.Extensions.ProcessExtension.EnablePrivilege(System.Diagnostics.Process,Vanara.Security.AccessControl.SystemPrivilege)</parameter>
</include>
</markup>
</param>
<param name="privilege">
<markup>
<include item="SMCMissingParamTag">
<parameter>param</parameter>
<parameter>privilege</parameter>
<parameter>M:Vanara.Extensions.ProcessExtension.EnablePrivilege(System.Diagnostics.Process,Vanara.Security.AccessControl.SystemPrivilege)</parameter>
</include>
</markup>
</param>
</member>
<member name="M:Vanara.Extensions.ProcessExtension.GetChildProcesses(System.Diagnostics.Process,System.Boolean)">
<summary>Gets the child processes.</summary>
<param name="p">The process.</param>
<param name="includeDescendants">if set to <c>true</c> include descendants of child processes as well.</param>
<returns>A <see cref="T:System.Collections.Generic.IEnumerable`1" /> reference for enumerating child processes.</returns>
</member>
<member name="M:Vanara.Extensions.ProcessExtension.GetIntegrityLevel(System.Diagnostics.Process)">
<summary>
The function gets the integrity level of the current process. Integrity level is only available on Windows Vista and newer operating systems, thus
GetProcessIntegrityLevel throws an exception if it is called on systems prior to Windows Vista.
</summary>
<param name="p">
<markup>
<include item="SMCMissingParamTag">
<parameter>param</parameter>
<parameter>p</parameter>
<parameter>M:Vanara.Extensions.ProcessExtension.GetIntegrityLevel(System.Diagnostics.Process)</parameter>
</include>
</markup>
</param>
<returns>Returns the integrity level of the current process.</returns>
<exception cref="T:System.ComponentModel.Win32Exception">
When any native Windows API call fails, the function throws a Win32Exception with the last error code.
</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="p" /> must be a valid <see cref="T:System.Diagnostics.Process" />.</exception>
</member>
<member name="M:Vanara.Extensions.ProcessExtension.GetParentProcess(System.Diagnostics.Process)">
<summary>
Gets the parent process.
</summary>
<param name="p">
<markup>
<include item="SMCMissingParamTag">
<parameter>param</parameter>
<parameter>p</parameter>
<parameter>M:Vanara.Extensions.ProcessExtension.GetParentProcess(System.Diagnostics.Process)</parameter>
</include>
</markup>
</param>
<returns>A <see cref="T:System.Diagnostics.Process" /> object for the process that called the specified process. <c>null</c> if no parent can be established.</returns>
<exception cref="T:System.ArgumentNullException">
<paramref name="p" /> must be a valid <see cref="T:System.Diagnostics.Process" />.</exception>
</member>
<member name="M:Vanara.Extensions.ProcessExtension.GetPrivileges(System.Diagnostics.Process)">
<summary>Gets the privileges for this process.</summary>
<param name="process">The process.</param>
<returns>
An enumeration of <see cref="T:Vanara.Security.AccessControl.PrivilegeAndAttributes" /> instances that include the process privileges and their associated attributes (enabled,
disabled, removed, etc.).
</returns>
</member>
<member name="M:Vanara.Extensions.ProcessExtension.HasPrivilege(System.Diagnostics.Process,Vanara.Security.AccessControl.SystemPrivilege)">
<summary>Determines whether the specified privilege is had by the process.</summary>
<param name="process">The process.</param>
<param name="priv">The privilege.</param>
<returns>
<c>true</c> if the process has the specified privilege; otherwise, <c>false</c>.</returns>
</member>
<member name="M:Vanara.Extensions.ProcessExtension.HasPrivileges(System.Diagnostics.Process,System.Boolean,Vanara.Security.AccessControl.SystemPrivilege[])">
<summary>Determines whether the specified privileges are had by the process.</summary>
<param name="process">The process.</param>
<param name="requireAll">if set to <c>true</c> require all privileges to be enabled in order to return <c>true</c>.</param>
<param name="privs">The privileges to check.</param>
<returns>
<c>true</c> if the process has the specified privilege; otherwise, <c>false</c>.</returns>
</member>
<member name="M:Vanara.Extensions.ProcessExtension.IsElevated(System.Diagnostics.Process)">
<summary>
The function gets the elevation information of the current process. It dictates whether the process is elevated or not. Token elevation is only
available on Windows Vista and newer operating systems, thus IsProcessElevated throws a C++ exception if it is called on systems prior to Windows
Vista. It is not appropriate to use this function to determine whether a process is run as administrator.
</summary>
<param name="p">
<markup>
<include item="SMCMissingParamTag">
<parameter>param</parameter>
<parameter>p</parameter>
<parameter>M:Vanara.Extensions.ProcessExtension.IsElevated(System.Diagnostics.Process)</parameter>
</include>
</markup>
</param>
<returns>Returns true if the process is elevated. Returns false if it is not.</returns>
<exception cref="T:System.ComponentModel.Win32Exception">
When any native Windows API call fails, the function throws a Win32Exception with the last error code.
</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="p" /> must be a valid <see cref="T:System.Diagnostics.Process" />.</exception>
</member>
<member name="M:Vanara.Extensions.ProcessExtension.IsRunningAsAdmin(System.Diagnostics.Process)">
<summary>
The function checks whether the primary access token of the process belongs to user account that is a member of the local Administrators group,
even if it currently is not elevated.
</summary>
<param name="proc">The process to check.</param>
<returns>
Returns true if the primary access token of the process belongs to user account that is a member of the local Administrators group. Returns false
if the token does not.
</returns>
</member>
<member name="M:Vanara.Extensions.ProcessExtension.RemovePrivilege(System.Diagnostics.Process,Vanara.Security.AccessControl.SystemPrivilege)">
<summary>
<markup>
<include item="SMCMissingTag">
<parameter>summary</parameter>
<parameter>M:Vanara.Extensions.ProcessExtension.RemovePrivilege(System.Diagnostics.Process,Vanara.Security.AccessControl.SystemPrivilege)</parameter>
</include>
</markup>
</summary>
<param name="process">
<markup>
<include item="SMCMissingParamTag">
<parameter>param</parameter>
<parameter>process</parameter>
<parameter>M:Vanara.Extensions.ProcessExtension.RemovePrivilege(System.Diagnostics.Process,Vanara.Security.AccessControl.SystemPrivilege)</parameter>
</include>
</markup>
</param>
<param name="privilege">
<markup>
<include item="SMCMissingParamTag">
<parameter>param</parameter>
<parameter>privilege</parameter>
<parameter>M:Vanara.Extensions.ProcessExtension.RemovePrivilege(System.Diagnostics.Process,Vanara.Security.AccessControl.SystemPrivilege)</parameter>
</include>
</markup>
</param>
</member>
<member name="T:Vanara.Extensions.ProcessIntegrityLevel">
<summary>
<markup>
<include item="SMCMissingTag">
<parameter>summary</parameter>
<parameter>T:Vanara.Extensions.ProcessIntegrityLevel</parameter>
</include>
</markup>
</summary>
</member>
<member name="T:Vanara.Extensions.ServiceControllerExtension">
<summary>
<markup>
<include item="SMCMissingTag">
<parameter>summary</parameter>
<parameter>T:Vanara.Extensions.ServiceControllerExtension</parameter>
</include>
</markup>
</summary>
</member>
<member name="M:Vanara.Extensions.ServiceControllerExtension.SetStartType(System.ServiceProcess.ServiceController,System.ServiceProcess.ServiceStartMode)">
<summary>
<markup>
<include item="SMCMissingTag">
<parameter>summary</parameter>
<parameter>M:Vanara.Extensions.ServiceControllerExtension.SetStartType(System.ServiceProcess.ServiceController,System.ServiceProcess.ServiceStartMode)</parameter>
</include>
</markup>
</summary>
<param name="svc">
<markup>
<include item="SMCMissingParamTag">
<parameter>param</parameter>
<parameter>svc</parameter>
<parameter>M:Vanara.Extensions.ServiceControllerExtension.SetStartType(System.ServiceProcess.ServiceController,System.ServiceProcess.ServiceStartMode)</parameter>
</include>
</markup>
</param>
<param name="mode">
<markup>
<include item="SMCMissingParamTag">
<parameter>param</parameter>
<parameter>mode</parameter>
<parameter>M:Vanara.Extensions.ServiceControllerExtension.SetStartType(System.ServiceProcess.ServiceController,System.ServiceProcess.ServiceStartMode)</parameter>
</include>
</markup>
</param>
</member>
<member name="T:Vanara.IO.VirtualDisk">
<summary>
<markup>
<include item="SMCMissingTag">
<parameter>summary</parameter>
<parameter>T:Vanara.IO.VirtualDisk</parameter>
</include>
</markup>
</summary>
</member>
<member name="M:Vanara.IO.VirtualDisk.Attach(System.Boolean,System.Boolean,System.Boolean,System.Security.AccessControl.FileSecurity)">
<summary>Attaches a virtual hard disk (VHD) or CD or DVD image file (ISO) by locating an appropriate VHD provider to accomplish the attachment.</summary>
<param name="readOnly">Attach the virtual disk as read-only.</param>
<param name="autoDetach">
If <c>false</c>, decouple the virtual disk lifetime from that of the VirtualDisk. The virtual disk will be attached until the Detach function is
called, even if all open instances of the virtual disk are disposed.
</param>
<param name="noDriveLetter">No drive letters are assigned to the disk's volumes.</param>
<param name="access">
An optional pointer to a FileSecurity instance to apply to the attached virtual disk. If this parameter is NULL, the security descriptor of the
virtual disk image file is used. Ensure that the security descriptor that AttachVirtualDisk applies to the attached virtual disk grants the write
attributes permission for the user, or that the security descriptor of the virtual disk image file grants the write attributes permission for the
user if you specify NULL for this parameter.If the security descriptor does not grant write attributes permission for a user, Shell displays the
following error when the user accesses the attached virtual disk: The Recycle Bin is corrupted.Do you want to empty the Recycle Bin for this drive?
</param>
</member>
<member name="M:Vanara.IO.VirtualDisk.Attach(Vanara.PInvoke.VirtDisk.ATTACH_VIRTUAL_DISK_FLAG,Vanara.PInvoke.VirtDisk.ATTACH_VIRTUAL_DISK_PARAMETERS@,System.IntPtr)">
<summary>Attaches a virtual hard disk (VHD) or CD or DVD image file (ISO) by locating an appropriate VHD provider to accomplish the attachment.</summary>
<param name="flags">A valid combination of values of the ATTACH_VIRTUAL_DISK_FLAG enumeration.</param>
<param name="param">A reference to a valid ATTACH_VIRTUAL_DISK_PARAMETERS structure that contains attachment parameter data.</param>
<param name="securityDescriptor">
An optional pointer to a SECURITY_DESCRIPTOR to apply to the attached virtual disk. If this parameter is NULL, the security descriptor of the virtual
disk image file is used.
<para>
Ensure that the security descriptor that AttachVirtualDisk applies to the attached virtual disk grants the write attributes permission for the user,
or that the security descriptor of the virtual disk image file grants the write attributes permission for the user if you specify NULL for this
parameter. If the security descriptor does not grant write attributes permission for a user, Shell displays the following error when the user
accesses the attached virtual disk: The Recycle Bin is corrupted. Do you want to empty the Recycle Bin for this drive?
</para></param>
</member>
<member name="P:Vanara.IO.VirtualDisk.Attached">
<summary>Indicates whether this virtual disk is currently attached.</summary>
</member>
<member name="P:Vanara.IO.VirtualDisk.BlockSize">
<summary>Block size of the VHD, in bytes.</summary>
</member>
<member name="M:Vanara.IO.VirtualDisk.Close">
<summary>Closes the instance of the virtual disk.</summary>
</member>
<member name="M:Vanara.IO.VirtualDisk.Compact">
<summary>Reduces the size of a virtual hard disk (VHD) backing store file.</summary>
</member>
<member name="M:Vanara.IO.VirtualDisk.Compact(System.Threading.CancellationToken,System.IProgress{System.Int32})">
<summary>Reduces the size of a virtual hard disk (VHD) backing store file.</summary>
<param name="cancellationToken">A cancellation token that can be used to cancel the operation. This value can be <c>null</c> to disable cancellation.</param>
<param name="progress">A class that implements <see cref="T:System.IProgress`1" /> that can be used to report on progress. This value can be <c>null</c> to disable progress reporting.</param>
<returns>
<c>true</c> if operation completed without error or cancellation; <c>false</c> otherwise.</returns>
</member>
<member name="M:Vanara.IO.VirtualDisk.Create(System.String,System.UInt64,System.Boolean,System.Security.AccessControl.FileSecurity)">
<summary>Creates a virtual hard disk (VHD) image file, either using default parameters or using an existing VHD or physical disk.</summary>
<param name="path">A valid file path that represents the path to the new virtual disk image file.</param>
<param name="size">The maximum virtual size, in bytes, of the virtual disk object. Must be a multiple of 512.</param>
<param name="dynamic">
<c>true</c> to grow the disk dynamically as content is added; <c>false</c> to pre-allocate all physical space necessary for the size of the virtual disk.
</param>
<param name="access">
An optional FileSecurity instance to apply to the attached virtual disk. If this parameter is <c>null</c>, the security descriptor of the virtual
disk image file is used. Ensure that the security descriptor that AttachVirtualDisk applies to the attached virtual disk grants the write attributes
permission for the user, or that the security descriptor of the virtual disk image file grants the write attributes permission for the user if you
specify <c>null</c> for this parameter. If the security descriptor does not grant write attributes permission for a user, Shell displays the
following error when the user accesses the attached virtual disk: The Recycle Bin is corrupted. Do you want to empty the Recycle Bin for this drive?
</param>
<returns>If successful, returns a valid <see cref="T:Vanara.IO.VirtualDisk" /> instance for the newly created virtual disk.</returns>
</member>
<member name="M:Vanara.IO.VirtualDisk.Create(System.String,System.UInt64,System.Boolean,System.UInt32,System.UInt32,System.Security.AccessControl.FileSecurity)">
<summary>Creates a virtual hard disk (VHD) image file, either using default parameters or using an existing VHD or physical disk.</summary>
<param name="path">A valid file path that represents the path to the new virtual disk image file.</param>
<param name="size">The maximum virtual size, in bytes, of the virtual disk object. Must be a multiple of 512.</param>
<param name="dynamic">
<c>true</c> to grow the disk dynamically as content is added; <c>false</c> to pre-allocate all physical space necessary for the size of the virtual disk.
</param>
<param name="blockSize">
Internal size of the virtual disk object blocks, in bytes. For VHDX this must be a multiple of 1 MB between 1 and 256 MB. For VHD 1 this must be set
to one of the following values: 0 (default), 0x80000 (512K), or 0x200000 (2MB)
</param>
<param name="logicalSectorSize">
Internal size of the virtual disk object sectors. For VHDX must be set to 512 (0x200) or 4096 (0x1000). For VHD 1 must be set to 512.
</param>
<param name="access">
An optional FileSecurity instance to apply to the attached virtual disk. If this parameter is <c>null</c>, the security descriptor of the virtual
disk image file is used. Ensure that the security descriptor that AttachVirtualDisk applies to the attached virtual disk grants the write attributes
permission for the user, or that the security descriptor of the virtual disk image file grants the write attributes permission for the user if you
specify <c>null</c> for this parameter. If the security descriptor does not grant write attributes permission for a user, Shell displays the
following error when the user accesses the attached virtual disk: The Recycle Bin is corrupted. Do you want to empty the Recycle Bin for this drive?
</param>
<returns>If successful, returns a valid <see cref="T:Vanara.IO.VirtualDisk" /> instance for the newly created virtual disk.</returns>
</member>
<member name="M:Vanara.IO.VirtualDisk.Create(System.String,Vanara.PInvoke.VirtDisk.CREATE_VIRTUAL_DISK_PARAMETERS@,Vanara.PInvoke.VirtDisk.CREATE_VIRTUAL_DISK_FLAG,Vanara.PInvoke.VirtDisk.VIRTUAL_DISK_ACCESS_MASK,System.IntPtr)">
<summary>Creates a virtual hard disk (VHD) image file.</summary>
<param name="path">A valid file path that represents the path to the new virtual disk image file.</param>
<param name="param">A reference to a valid CREATE_VIRTUAL_DISK_PARAMETERS structure that contains creation parameter data.</param>
<param name="flags">Creation flags, which must be a valid combination of the CREATE_VIRTUAL_DISK_FLAG enumeration.</param>
<param name="mask">The VIRTUAL_DISK_ACCESS_MASK value to use when opening the newly created virtual disk file.</param>
<param name="securityDescriptor">An optional pointer to a SECURITY_DESCRIPTOR to apply to the virtual disk image file. If this parameter is IntPtr.Zero, the parent directory's security descriptor will be used.</param>
<returns>If successful, returns a valid <see cref="T:Vanara.IO.VirtualDisk" /> instance for the newly created virtual disk.</returns>
</member>
<member name="M:Vanara.IO.VirtualDisk.CreateDifferencing(System.String,System.String,System.Security.AccessControl.FileSecurity)">
<summary>Creates a virtual hard disk (VHD) image file, either using default parameters or using an existing VHD or physical disk.</summary>
<param name="path">A valid string that represents the path to the new virtual disk image file.</param>
<param name="parentPath">
<markup>
<include item="SMCMissingParamTag">
<parameter>param</parameter>
<parameter>parentPath</parameter>
<parameter>M:Vanara.IO.VirtualDisk.CreateDifferencing(System.String,System.String,System.Security.AccessControl.FileSecurity)</parameter>
</include>
</markup>
</param>
<param name="access">
An optional pointer to a FileSecurity instance to apply to the attached virtual disk. If this parameter is NULL, the security descriptor of the
virtual disk image file is used. Ensure that the security descriptor that AttachVirtualDisk applies to the attached virtual disk grants the write
attributes permission for the user, or that the security descriptor of the virtual disk image file grants the write attributes permission for the
user if you specify NULL for this parameter.If the security descriptor does not grant write attributes permission for a user, Shell displays the
following error when the user accesses the attached virtual disk: The Recycle Bin is corrupted.Do you want to empty the Recycle Bin for this drive?
</param>
<returns>
<markup>
<include item="SMCMissingTag">
<parameter>returns</parameter>
<parameter>M:Vanara.IO.VirtualDisk.CreateDifferencing(System.String,System.String,System.Security.AccessControl.FileSecurity)</parameter>
</include>
</markup>
</returns>
</member>
<member name="M:Vanara.IO.VirtualDisk.CreateFromSource(System.String,System.String)">
<summary>Creates a virtual hard disk (VHD) image file, either using default parameters or using an existing VHD or physical disk.</summary>
<param name="path">A valid file path that represents the path to the new virtual disk image file.</param>
<param name="sourcePath">
A fully qualified path to pre-populate the new virtual disk object with block data from an existing disk. This path may refer to a virtual
disk or a physical disk.
</param>
<returns>If successful, returns a valid <see cref="T:Vanara.IO.VirtualDisk" /> instance for the newly created virtual disk.</returns>
</member>
<member name="M:Vanara.IO.VirtualDisk.CreateFromSource(System.String,System.String,System.Threading.CancellationToken,System.IProgress{System.Int32})">
<summary>Creates a virtual hard disk (VHD) image file, either using default parameters or using an existing VHD or physical disk.</summary>
<param name="path">A valid file path that represents the path to the new virtual disk image file.</param>
<param name="sourcePath">
A fully qualified path to pre-populate the new virtual disk object with block data from an existing disk. This path may refer to a virtual
disk or a physical disk.
</param>
<param name="cancellationToken">A cancellation token that can be used to cancel the operation. This value can be <c>null</c> to disable cancellation.</param>
<param name="progress">A class that implements <see cref="T:System.IProgress`1" /> that can be used to report on progress. This value can be <c>null</c> to disable progress reporting.</param>
<returns>If successful, returns a valid <see cref="T:Vanara.IO.VirtualDisk" /> instance for the newly created virtual disk.</returns>
</member>
<member name="M:Vanara.IO.VirtualDisk.Detach">
<summary>
Detaches a virtual hard disk (VHD) or CD or DVD image file (ISO) by locating an appropriate virtual disk provider to accomplish the operation.
</summary>
</member>
<member name="M:Vanara.IO.VirtualDisk.Detach(System.String)">
<summary>
Detach a virtual disk that was previously attached with the ATTACH_VIRTUAL_DISK_FLAG_PERMANENT_LIFETIME flag or calling <see cref="M:Vanara.IO.VirtualDisk.Attach(System.Boolean,System.Boolean,System.Boolean,System.Security.AccessControl.FileSecurity)" /> and setting autoDetach to <c>false</c>.
</summary>
<param name="path">A valid path to the virtual disk image to detach.</param>
</member>
<member name="P:Vanara.IO.VirtualDisk.DiskType">
<summary>The device identifier.</summary>
</member>
<member name="M:Vanara.IO.VirtualDisk.Dispose">
<summary>Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.</summary>
</member>
<member name="P:Vanara.IO.VirtualDisk.Enabled">
<summary>Whether RCT is turned on. TRUE if RCT is turned on; otherwise FALSE.</summary>
</member>
<member name="M:Vanara.IO.VirtualDisk.Expand(System.UInt64)">
<summary>Increases the size of a fixed or dynamic virtual hard disk (VHD).</summary>
<param name="newSize">New size, in bytes, for the expansion request.</param>
</member>
<member name="M:Vanara.IO.VirtualDisk.Expand(System.UInt64,System.Threading.CancellationToken,System.IProgress{System.Int32})">
<summary>Increases the size of a fixed or dynamic virtual hard disk (VHD).</summary>
<param name="newSize">New size, in bytes, for the expansion request.</param>
<param name="cancellationToken">A cancellation token that can be used to cancel the operation. This value can be <c>null</c> to disable cancellation.</param>
<param name="progress">A class that implements <see cref="T:System.IProgress`1" /> that can be used to report on progress. This value can be <c>null</c> to disable progress reporting.</param>
<returns>
<c>true</c> if operation completed without error or cancellation; <c>false</c> otherwise.</returns>
</member>
<member name="P:Vanara.IO.VirtualDisk.FragmentationPercentage">
<summary>The fragmentation level of the virtual disk.</summary>
</member>
<member name="M:Vanara.IO.VirtualDisk.GetAllAttachedVirtualDiskPaths">
<summary>Gets the list of all the loopback mounted virtual disks.</summary>
<returns>An enumeration of all the loopback mounted virtual disks physical paths.</returns>
</member>
<member name="P:Vanara.IO.VirtualDisk.Handle">
<summary>Gets the safe handle for the current virtual disk.</summary>
</member>
<member name="P:Vanara.IO.VirtualDisk.Identifier">
<summary>Unique identifier of the VHD.</summary>
</member>
<member name="P:Vanara.IO.VirtualDisk.Is4kAligned">
<summary>Indicates whether the virtual disk is 4 KB aligned.</summary>
</member>
<member name="P:Vanara.IO.VirtualDisk.IsLoaded">
<summary>
Indicates whether the virtual disk is currently mounted and in use. TRUE if the virtual disk is currently mounted and in use; otherwise FALSE.
</summary>
</member>
<member name="P:Vanara.IO.VirtualDisk.IsRemote">
<summary>Indicates whether the physical disk is remote.</summary>
</member>
<member name="P:Vanara.IO.VirtualDisk.LogicalSectorSize">
<summary>The logical sector size of the physical disk.</summary>
</member>
<member name="M:Vanara.IO.VirtualDisk.Merge(System.UInt32,System.UInt32)">
<summary>Merges a child virtual hard disk (VHD) in a differencing chain with parent disks in the chain.</summary>
<param name="sourceDepth">Depth from the leaf from which to begin the merge. The leaf is at depth 1.</param>
<param name="targetDepth">Depth from the leaf to target the merge. The leaf is at depth 1.</param>
</member>
<member name="M:Vanara.IO.VirtualDisk.MergeWithParent">
<summary>Merges a child virtual hard disk (VHD) in a differencing chain with its immediate parent disk in the chain.</summary>
</member>
<member name="P:Vanara.IO.VirtualDisk.MostRecentId">
<summary>
The change tracking identifier for the change that identifies the state of the virtual disk that you want to use as the basis of comparison to
determine whether the NewerChanges member reports new changes.
</summary>
</member>
<member name="P:Vanara.IO.VirtualDisk.NewerChanges">
<summary>
Whether the virtual disk has changed since the change identified by the MostRecentId member occurred. TRUE if the virtual disk has changed since the
change identified by the MostRecentId member occurred; otherwise FALSE.
</summary>
</member>
<member name="M:Vanara.IO.VirtualDisk.Open(System.String,System.Boolean,System.Boolean,System.Boolean)">
<summary>Creates an instance of a Virtual Disk from a file.</summary>
<param name="path">A valid path to the virtual disk image to open.</param>
<param name="readOnly">If TRUE, indicates the file backing store is to be opened as read-only.</param>
<param name="getInfoOnly">If TRUE, indicates the handle is only to be used to get information on the virtual disk.</param>
<param name="noParents">Open the VHD file (backing store) without opening any differencing-chain parents. Used to correct broken parent links. This flag is not supported for ISO virtual disks.</param>
<returns>
<markup>
<include item="SMCMissingTag">
<parameter>returns</parameter>
<parameter>M:Vanara.IO.VirtualDisk.Open(System.String,System.Boolean,System.Boolean,System.Boolean)</parameter>
</include>
</markup>
</returns>
</member>
<member name="M:Vanara.IO.VirtualDisk.Open(System.String,Vanara.PInvoke.VirtDisk.OPEN_VIRTUAL_DISK_FLAG,Vanara.PInvoke.VirtDisk.OPEN_VIRTUAL_DISK_PARAMETERS,Vanara.PInvoke.VirtDisk.VIRTUAL_DISK_ACCESS_MASK)">
<summary>Creates an instance of a Virtual Disk from a file.</summary>
<param name="path">A valid path to the virtual disk image to open.</param>
<param name="flags">A valid combination of values of the OPEN_VIRTUAL_DISK_FLAG enumeration.</param>
<param name="param">A valid OPEN_VIRTUAL_DISK_PARAMETERS structure.</param>
<param name="mask">
<markup>
<include item="SMCMissingParamTag">
<parameter>param</parameter>
<parameter>mask</parameter>
<parameter>M:Vanara.IO.VirtualDisk.Open(System.String,Vanara.PInvoke.VirtDisk.OPEN_VIRTUAL_DISK_FLAG,Vanara.PInvoke.VirtDisk.OPEN_VIRTUAL_DISK_PARAMETERS,Vanara.PInvoke.VirtDisk.VIRTUAL_DISK_ACCESS_MASK)</parameter>
</include>
</markup>
</param>
<returns>
<markup>
<include item="SMCMissingTag">
<parameter>returns</parameter>
<parameter>M:Vanara.IO.VirtualDisk.Open(System.String,Vanara.PInvoke.VirtDisk.OPEN_VIRTUAL_DISK_FLAG,Vanara.PInvoke.VirtDisk.OPEN_VIRTUAL_DISK_PARAMETERS,Vanara.PInvoke.VirtDisk.VIRTUAL_DISK_ACCESS_MASK)</parameter>
</include>
</markup>
</returns>
</member>
<member name="P:Vanara.IO.VirtualDisk.ParentBackingStore">
<summary>The path of the parent backing store, if it can be resolved.</summary>
</member>
<member name="P:Vanara.IO.VirtualDisk.ParentIdentifier">
<summary>Unique identifier of the parent disk backing store.</summary>
</member>
<member name="P:Vanara.IO.VirtualDisk.ParentPaths">
<summary>The path of the parent backing store, if it can be resolved.</summary>
</member>
<member name="P:Vanara.IO.VirtualDisk.ParentTimeStamp">
<summary>Internal time stamp of the parent disk backing store.</summary>
</member>
<member name="P:Vanara.IO.VirtualDisk.PhysicalPath">
<summary>Retrieves the path to the physical device object that contains a virtual hard disk (VHD) or CD or DVD image file (ISO).</summary>
</member>
<member name="P:Vanara.IO.VirtualDisk.PhysicalSectorSize">
<summary>The physical sector size of the physical disk.</summary>
</member>
<member name="P:Vanara.IO.VirtualDisk.PhysicalSize">
<summary>Physical size of the VHD on disk, in bytes.</summary>
</member>
<member name="P:Vanara.IO.VirtualDisk.ProviderSubtype">
<summary>Provider-specific subtype.</summary>
</member>
<member name="M:Vanara.IO.VirtualDisk.Resize(System.UInt64)">
<summary>Resizes a virtual disk.</summary>
<param name="newSize">New size, in bytes, for the expansion request. Setting this value to '0' will shrink the disk to the smallest safe virtual size possible without truncating past any existing partitions.</param>
</member>
<member name="M:Vanara.IO.VirtualDisk.Resize(System.UInt64,System.Threading.CancellationToken,System.IProgress{System.Int32})">
<summary>Resizes a virtual disk.</summary>
<param name="newSize">New size, in bytes, for the expansion request.</param>
<param name="cancellationToken">A cancellation token that can be used to cancel the operation. This value can be <c>null</c> to disable cancellation.</param>
<param name="progress">A class that implements <see cref="T:System.IProgress`1" /> that can be used to report on progress. This value can be <c>null</c> to disable progress reporting.</param>
<returns>
<c>true</c> if operation completed without error or cancellation; <c>false</c> otherwise.</returns>
</member>
<member name="P:Vanara.IO.VirtualDisk.SectorSize">
<summary>Sector size of the VHD, in bytes.</summary>
</member>
<member name="P:Vanara.IO.VirtualDisk.SmallestSafeVirtualSize">
<summary>The smallest safe minimum size of the virtual disk.</summary>
</member>
<member name="M:Vanara.IO.VirtualDisk.UnsafeResize(System.UInt64)">
<summary>Resizes a virtual disk without checking the virtual disk's partition table to ensure that this truncation is safe.
<note type="warning">This method can cause unrecoverable data loss; use with care.</note></summary>
<param name="newSize">New size, in bytes, for the expansion request.</param>
</member>
<member name="P:Vanara.IO.VirtualDisk.VendorId">
<summary>Vendor-unique identifier.</summary>
</member>
<member name="P:Vanara.IO.VirtualDisk.VhdPhysicalSectorSize">
<summary>The physical sector size of the virtual disk.</summary>
</member>
<member name="P:Vanara.IO.VirtualDisk.VirtualDiskId">
<summary>The identifier that is uniquely created when a user first creates the virtual disk to attempt to uniquely identify that virtual disk.</summary>
</member>
<member name="P:Vanara.IO.VirtualDisk.VirtualSize">
<summary>Virtual size of the VHD, in bytes.</summary>
</member>
<member name="T:Vanara.IO.VirtualDisk.DeviceType">
<summary>
<markup>
<include item="SMCMissingTag">
<parameter>summary</parameter>
<parameter>T:Vanara.IO.VirtualDisk.DeviceType</parameter>
</include>
</markup>
</summary>
</member>
<member name="F:Vanara.IO.VirtualDisk.DeviceType.Unknown">
<summary>Device type is unknown or not valid.</summary>
</member>
<member name="F:Vanara.IO.VirtualDisk.DeviceType.Iso">
<summary>
CD or DVD image file device type. (.iso file)
<para><c>Windows 7 and Windows Server 2008 R2:</c> This value is not supported before Windows 8 and Windows Server 2012.</para></summary>
</member>
<member name="F:Vanara.IO.VirtualDisk.DeviceType.Vhd">
<summary>Virtual hard disk device type. (.vhd file)</summary>
</member>
<member name="F:Vanara.IO.VirtualDisk.DeviceType.Vhdx">
<summary>
VHDX format virtual hard disk device type. (.vhdx file)
<para><c>Windows 7 and Windows Server 2008 R2:</c> This value is not supported before Windows 8 and Windows Server 2012.</para></summary>
</member>
<member name="F:Vanara.IO.VirtualDisk.DeviceType.VhdSet">
<summary></summary>
</member>
<member name="T:Vanara.IO.VirtualDisk.Subtype">
<summary>
<markup>
<include item="SMCMissingTag">
<parameter>summary</parameter>
<parameter>T:Vanara.IO.VirtualDisk.Subtype</parameter>
</include>
</markup>
</summary>
</member>
</members>
</doc>

15138
docs/Vanara.UI.xml Normal file

File diff suppressed because it is too large Load Diff

34
docs/Web.Config Normal file
View File

@ -0,0 +1,34 @@
<?xml version="1.0"?>
<configuration xmlns="http://schemas.microsoft.com/.NetConfiguration/v2.0">
<system.web>
<customErrors mode="On" defaultRedirect="~/html/GeneralError.htm">
<error statusCode="404" redirect="~/html/PageNotFound.htm" />
</customErrors>
<compilation debug="false">
<assemblies>
<add assembly="System.Web.Extensions, Version=3.5.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35" />
</assemblies>
</compilation>
<pages>
<namespaces>
<add namespace="System"/>
<add namespace="System.Collections.Generic"/>
<add namespace="System.Globalization"/>
<add namespace="System.IO"/>
<add namespace="System.Text"/>
<add namespace="System.Text.RegularExpressions"/>
<add namespace="System.Web"/>
<add namespace="System.Web.Script.Serialization"/>
<add namespace="System.Web.UI"/>
<add namespace="System.Xml"/>
<add namespace="System.Xml.Serialization" />
<add namespace="System.Xml.XPath"/>
</namespaces>
</pages>
</system.web>
<appSettings>
<!-- Increase this value if you get an "Operation is not valid due to the current state of the object" error
when using the search page. -->
<add key="aspnet:MaxJsonDeserializerMembers" value="100000" />
</appSettings>
</configuration>

38082
docs/WebKI.xml Normal file

File diff suppressed because it is too large Load Diff

17708
docs/WebTOC.xml Normal file

File diff suppressed because it is too large Load Diff

1
docs/fti/FTI_100.json Normal file

File diff suppressed because one or more lines are too long

1
docs/fti/FTI_101.json Normal file

File diff suppressed because one or more lines are too long

1
docs/fti/FTI_102.json Normal file

File diff suppressed because one or more lines are too long

1
docs/fti/FTI_103.json Normal file

File diff suppressed because one or more lines are too long

1
docs/fti/FTI_104.json Normal file

File diff suppressed because one or more lines are too long

1
docs/fti/FTI_105.json Normal file

File diff suppressed because one or more lines are too long

1
docs/fti/FTI_106.json Normal file
View File

@ -0,0 +1 @@
{"jean":[215810049,993460225],"journalrecordproc":[72810497,363069441],"jobs":[55705602,78839812,141819905,232456194,303759361,607518721,767557633,823197697],"jobtitle":[619184130,974192644,1031077890],"joining":[15728641,55705604,80936961,232456196,363790338,444465153,486342657,517275649,683474946,992804865],"jpg":[100139009,103743489,112787457,152305665,250871810,303759364,374996993,767557636,871432193,878772226,949026818,1029636097],"jump":[55705601,81920002,164560897,208863233,232456193,239140875,242548746,277020674,303759361,363790337,367067137,426901509,529006596,561577986,580059137,590938114,609026049,621871105,674824196,683474945,685506561,748617731,749862914,767557633,775356419,992739329,1013186561,1027014657],"january":[322306049,408944641,586547201,635043841,854917121],"junction":[151584769,268828674,837419009,929890306,952041474],"jaffe":[14745601,48300033,224657409],"jpeg":[15007745,60424193,70057985,190644225,274530308,279445506,303759374,314638337,323813377,394461185,399048705,413466625,511705089,540475393,578158596,720568321,738459650,743636994,767557646,788660225,838270978,862650369,871890945,897777665,918683649],"jscript":[34799617],"june":[322306049,408944641,586547201,635043841,854917121],"justification":[113049604,135266305,188022785,200146948,424607745,515964929],"johab":[789708801],"johap":[789708801],"junctions":[151584771,164954113,178978817,201195521,268828678,724500481,734658561,837419012,929890310,952041478],"join":[55705618,83165187,160104449,177340417,232456210,267845633,332922881,363790337,374013953,436338689,486342657,489881601,497483778,517275649,536608769,557383681,628817921,683474945,802226177,921370625],"jit":[246743041,303759361,767557633],"journaling":[534708225],"japanese":[789708801],"joined":[55705610,160694273,201326593,232456202,267845633,317980673,332922881,363790338,364642305,394002433,460324865,489881601,620298241,683474946,708182017,787349505,887816193,921370625,946143233],"johab_charset":[789708801],"jeff":[971243521],"journals":[734658561],"junk":[440467457,463077377,801046529],"job":[45285377,55705604,59179009,78839809,152502273,232456196,363790338,367853569,391380993,427884545,534708225,683474946,694550530,699203585,775356418,870645761,909246465,945094658],"justifies":[800653314],"just":[21168129,47513601,66125825,161742849,189923329,246743041,303759364,334364673,363790337,365756419,371654657,440270849,468582401,534052865,534708225,544997377,550240257,555745281,605618177,617086977,640024577,683474945,767557636,775356417,811270145,915603457,916979713,956104705,984743937,1005584385],"journal":[55705605,56557570,216989697,232456197,246349832,249298945,316276739,363790340,449380353,643760129,683474948,713949189,720699394,734658561,754384897,775356418,980221955],"journalplaybackproc":[72810497,363069441],"july":[322306049,408944641,586547201,635043841,854917121],"justifying":[191496193,776208385,871628801]}

1
docs/fti/FTI_107.json Normal file

File diff suppressed because one or more lines are too long

1
docs/fti/FTI_108.json Normal file

File diff suppressed because one or more lines are too long

1
docs/fti/FTI_109.json Normal file

File diff suppressed because one or more lines are too long

1
docs/fti/FTI_110.json Normal file

File diff suppressed because one or more lines are too long

1
docs/fti/FTI_111.json Normal file

File diff suppressed because one or more lines are too long

1
docs/fti/FTI_112.json Normal file

File diff suppressed because one or more lines are too long

1
docs/fti/FTI_113.json Normal file

File diff suppressed because one or more lines are too long

1
docs/fti/FTI_114.json Normal file

File diff suppressed because one or more lines are too long

1
docs/fti/FTI_115.json Normal file

File diff suppressed because one or more lines are too long

1
docs/fti/FTI_116.json Normal file

File diff suppressed because one or more lines are too long

1
docs/fti/FTI_117.json Normal file

File diff suppressed because one or more lines are too long

1
docs/fti/FTI_118.json Normal file

File diff suppressed because one or more lines are too long

1
docs/fti/FTI_119.json Normal file

File diff suppressed because one or more lines are too long

1
docs/fti/FTI_120.json Normal file

File diff suppressed because one or more lines are too long

1
docs/fti/FTI_121.json Normal file
View File

@ -0,0 +1 @@
{"yellow":[63635458,285016065,597819393],"yoriginsrc":[617086979],"yhotspot":[234487809,652673027,969408513],"yesterday":[504037377],"yoffsetpercent":[276824065],"yyyy":[44433409,65863681,137887745,141361153,181993473,234946561,237830145,278921217,297533441,334626817,397017089,440401921,445972481,534380545,615186433,617349121,647823361,649461761,688914433,800522241,826015745,889585665,893190145,1012858881],"year":[31195137,40042498,45285377,87162881,166133761,227868673,278331393,375586817,408944642,445775874,452132866,462356482,502530049,504037377,554631169,586547201,611385345,635043844,660733953,672530433,683802625,750649349,775356417,806813697,836501506,971440133,988610561,1000669188],"yoffset":[349110275,496435201,810614785],"ybitmap":[157286405,531365889,571408385,717291524,760414209,824770565],"yext":[257753089,508493825,560136196],"yield":[55705601,232456193,363790337,639893505,683474945,688062465],"yes":[55705602,63504385,108134401,135462915,232456194,300941313,363790337,681050113,683474945,754647041,807403521,827785217],"years":[123207681,159252481,242876417,298975233,388562945,419102721,420937729,463470593,472711169,556466177,591069185,634978305,652148737,660078593,664535041,665911297,676921345,680591361,713097217,729219073,751173633,798294017,823721985,829423617,848035841,882311169,913833985,925106177,926220289,931594241,1014956033],"yorigindest":[617086979],"yielding":[303759361,767557633,915210241],"yarget":[67043329,363790337,683474945]}

1
docs/fti/FTI_122.json Normal file

File diff suppressed because one or more lines are too long

1
docs/fti/FTI_95.json Normal file
View File

@ -0,0 +1 @@
{"_barservice":[127795202],"_logon":[305790977,443613185],"_newenum":[226361348,469368833,765526020,870449153,873398273,1034158081],"_name":[1004404739],"_sys_mod_path":[403570689,485621761,1000800257]}

1
docs/fti/FTI_97.json Normal file

File diff suppressed because one or more lines are too long

1
docs/fti/FTI_98.json Normal file

File diff suppressed because one or more lines are too long

1
docs/fti/FTI_99.json Normal file

File diff suppressed because one or more lines are too long

1
docs/fti/FTI_Files.json Normal file

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

View File

@ -0,0 +1,3 @@
<html><head><meta http-equiv="X-UA-Compatible" content="IE=edge" /><link rel="shortcut icon" href="../icons/favicon.ico" /><link rel="stylesheet" type="text/css" href="../styles/branding.css" /><link rel="stylesheet" type="text/css" href="../styles/branding-en-US.css" /><script type="text/javascript" src="../scripts/branding.js"> </script><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>SAFEARRAYBOUND Fields</title><meta name="Language" content="en-us" /><meta name="System.Keywords" content="SAFEARRAYBOUND structure, fields" /><meta name="Microsoft.Help.Id" content="Fields.T:Vanara.PInvoke.OleAut32.SAFEARRAYBOUND" /><meta name="Microsoft.Help.ContentType" content="Reference" /><meta name="BrandingAware" content="true" /><meta name="container" content="Vanara.PInvoke" /><meta name="file" content="004d0aa5-bfb4-8ab1-07f6-a6dd85bc6758" /><meta name="guid" content="004d0aa5-bfb4-8ab1-07f6-a6dd85bc6758" /><link rel="stylesheet" type="text/css" href="../styles/branding-Website.css" /><script type="text/javascript" src="../scripts/jquery-1.11.0.min.js"></script><script type="text/javascript" src="../scripts/branding-Website.js"></script><script type="text/javascript" src="../scripts/clipboard.min.js"></script></head><body onload="OnLoad('cs')"><input type="hidden" id="userDataCache" class="userDataStyle" /><div class="pageHeader" id="PageHeader">Vanara API Documentation<form id="SearchForm" method="get" action="#" onsubmit="javascript:TransferToSearchPage(); return false;"><input id="SearchTextBox" type="text" maxlength="200" /><button id="SearchButton" type="submit"></button></form></div><div class="pageBody"><div class="leftNav" id="leftNav"><div id="tocNav"><div class="toclevel0" data-toclevel="0"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="d22522ce-4106-42b2-81eb-cb37a0f36df8.htm" title="Vanara API Documentation" tocid="roottoc">Vanara API Documentation</a></div><div class="toclevel0" data-toclevel="0"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="c0250011-c1b9-bc9a-b501-96a9795f44a5.htm" title="Vanara.PInvoke" tocid="c0250011-c1b9-bc9a-b501-96a9795f44a5">Vanara.PInvoke</a></div><div class="toclevel0" data-toclevel="0"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="26b9379e-6a98-9d73-4ec1-02ce4a5ca1b2.htm" title="OleAut32.SAFEARRAYBOUND Structure" tocid="26b9379e-6a98-9d73-4ec1-02ce4a5ca1b2">OleAut32.SAFEARRAYBOUND Structure</a></div><div class="toclevel1 current" data-toclevel="1" data-childrenloaded="true"><a class="tocExpanded" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="004d0aa5-bfb4-8ab1-07f6-a6dd85bc6758.htm" title="SAFEARRAYBOUND Fields" tocid="004d0aa5-bfb4-8ab1-07f6-a6dd85bc6758">SAFEARRAYBOUND Fields</a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="108d35a4-7ef8-dd6d-4cce-76b691bc9e6e.htm" title="cElements Field" tocid="108d35a4-7ef8-dd6d-4cce-76b691bc9e6e">cElements Field</a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="81ec636a-636d-7bac-fdd6-fbca8f839e00.htm" title="lLbound Field" tocid="81ec636a-636d-7bac-fdd6-fbca8f839e00">lLbound Field</a></div></div><div id="tocResizableEW" onmousedown="OnMouseDown(event);"></div><div id="TocResize" class="tocResize"><img id="ResizeImageIncrease" src="../icons/TocOpen.gif" onclick="OnIncreaseToc()" alt="Click or drag to resize" title="Click or drag to resize" /><img id="ResizeImageReset" src="../icons/TocClose.gif" style="display:none" onclick="OnResetToc()" alt="Click or drag to resize" title="Click or drag to resize" /></div></div><div class="topicContent" id="TopicContent"><table class="titleTable"><tr><td class="logoColumn"><img src="../icons/Help.png" /></td><td class="titleColumn"><h1>SAFEARRAYBOUND Fields</h1></td></tr></table><span class="introStyle"></span> <p>The <a href="26b9379e-6a98-9d73-4ec1-02ce4a5ca1b2.htm">OleAut32<span id="LSTB0F9DB85_0"></span><script type="text/javascript">AddLanguageSpecificTextSet("LSTB0F9DB85_0?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>SAFEARRAYBOUND</a> type exposes the following members.</p><div class="collapsibleAreaRegion"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID0RB')" onkeypress="SectionExpandCollapse_CheckKey('ID0RB', event)" tabindex="0"><img id="ID0RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />Fields</span></div><div id="ID0RBSection" class="collapsibleSection"><table class="members" id="fieldList"><tr><th class="iconColumn">
 
</th><th>Name</th><th>Description</th></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubfield.gif" alt="Public field" title="Public field" /></td><td><a href="108d35a4-7ef8-dd6d-4cce-76b691bc9e6e.htm">cElements</a></td><td><div class="summary">The number of elements in the dimension.</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubfield.gif" alt="Public field" title="Public field" /></td><td><a href="81ec636a-636d-7bac-fdd6-fbca8f839e00.htm">lLbound</a></td><td><div class="summary">The lower bound of the dimension.</div></td></tr></table><a href="#PageHeader">Top</a></div><div class="collapsibleAreaRegion" id="seeAlsoSection"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID1RB')" onkeypress="SectionExpandCollapse_CheckKey('ID1RB', event)" tabindex="0"><img id="ID1RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />See Also</span></div><div id="ID1RBSection" class="collapsibleSection"><h4 class="subHeading">Reference</h4><div class="seeAlsoStyle"><a href="26b9379e-6a98-9d73-4ec1-02ce4a5ca1b2.htm">OleAut32<span id="LSTB0F9DB85_1"></span><script type="text/javascript">AddLanguageSpecificTextSet("LSTB0F9DB85_1?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>SAFEARRAYBOUND Structure</a></div><div class="seeAlsoStyle"><a href="c0250011-c1b9-bc9a-b501-96a9795f44a5.htm">Vanara.PInvoke Namespace</a></div></div></div></div><div id="pageFooter" class="pageFooter"> </div></body></html>

File diff suppressed because one or more lines are too long

View File

@ -0,0 +1,5 @@
<html><head><meta http-equiv="X-UA-Compatible" content="IE=edge" /><link rel="shortcut icon" href="../icons/favicon.ico" /><link rel="stylesheet" type="text/css" href="../styles/branding.css" /><link rel="stylesheet" type="text/css" href="../styles/branding-en-US.css" /><script type="text/javascript" src="../scripts/branding.js"> </script><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>TaskSchd.ITaskFolderCollection.GetEnumerator Method </title><meta name="Language" content="en-us" /><meta name="System.Keywords" content="GetEnumerator method" /><meta name="System.Keywords" content="TaskSchd.ITaskFolderCollection.GetEnumerator method" /><meta name="Microsoft.Help.F1" content="Vanara.PInvoke.TaskSchd.ITaskFolderCollection.GetEnumerator" /><meta name="Microsoft.Help.Id" content="M:Vanara.PInvoke.TaskSchd.ITaskFolderCollection.GetEnumerator" /><meta name="Description" content="Returns an enumerator that iterates through a collection." /><meta name="Microsoft.Help.ContentType" content="Reference" /><meta name="BrandingAware" content="true" /><meta name="container" content="Vanara.PInvoke" /><meta name="file" content="005592f1-c8e3-f17e-8017-e205e0192b7f" /><meta name="guid" content="005592f1-c8e3-f17e-8017-e205e0192b7f" /><link rel="stylesheet" type="text/css" href="../styles/branding-Website.css" /><script type="text/javascript" src="../scripts/jquery-1.11.0.min.js"></script><script type="text/javascript" src="../scripts/branding-Website.js"></script><script type="text/javascript" src="../scripts/clipboard.min.js"></script></head><body onload="OnLoad('cs')"><input type="hidden" id="userDataCache" class="userDataStyle" /><div class="pageHeader" id="PageHeader">Vanara API Documentation<form id="SearchForm" method="get" action="#" onsubmit="javascript:TransferToSearchPage(); return false;"><input id="SearchTextBox" type="text" maxlength="200" /><button id="SearchButton" type="submit"></button></form></div><div class="pageBody"><div class="leftNav" id="leftNav"><div id="tocNav"><div class="toclevel0" data-toclevel="0"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="d22522ce-4106-42b2-81eb-cb37a0f36df8.htm" title="Vanara API Documentation" tocid="roottoc">Vanara API Documentation</a></div><div class="toclevel0" data-toclevel="0"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="c0250011-c1b9-bc9a-b501-96a9795f44a5.htm" title="Vanara.PInvoke" tocid="c0250011-c1b9-bc9a-b501-96a9795f44a5">Vanara.PInvoke</a></div><div class="toclevel0" data-toclevel="0"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="1068b4c3-da1d-b496-3e69-410f8d4c5a50.htm" title="TaskSchd.ITaskFolderCollection Interface" tocid="1068b4c3-da1d-b496-3e69-410f8d4c5a50">TaskSchd.ITaskFolderCollection Interface</a></div><div class="toclevel1" data-toclevel="1" data-childrenloaded="true"><a class="tocExpanded" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="bb029e1c-51d8-1d4c-981f-b652050d06df.htm" title="ITaskFolderCollection Methods" tocid="bb029e1c-51d8-1d4c-981f-b652050d06df">ITaskFolderCollection Methods</a></div><div class="toclevel2 current" data-toclevel="2"><a data-tochassubtree="false" href="005592f1-c8e3-f17e-8017-e205e0192b7f.htm" title="GetEnumerator Method " tocid="005592f1-c8e3-f17e-8017-e205e0192b7f">GetEnumerator Method </a></div></div><div id="tocResizableEW" onmousedown="OnMouseDown(event);"></div><div id="TocResize" class="tocResize"><img id="ResizeImageIncrease" src="../icons/TocOpen.gif" onclick="OnIncreaseToc()" alt="Click or drag to resize" title="Click or drag to resize" /><img id="ResizeImageReset" src="../icons/TocClose.gif" style="display:none" onclick="OnResetToc()" alt="Click or drag to resize" title="Click or drag to resize" /></div></div><div class="topicContent" id="TopicContent"><table class="titleTable"><tr><td class="logoColumn"><img src="../icons/Help.png" /></td><td class="titleColumn"><h1>TaskSchd<span id="LSTF77BE5EE_0"></span><script type="text/javascript">AddLanguageSpecificTextSet("LSTF77BE5EE_0?cpp=::|nu=.");</script>ITaskFolderCollection<span id="LSTF77BE5EE_1"></span><script type="text/javascript">AddLanguageSpecificTextSet("LSTF77BE5EE_1?cpp=::|nu=.");</script>GetEnumerator Method </h1></td></tr></table><span class="introStyle"></span> <div class="summary">Returns an enumerator that iterates through a collection.</div><p> </p>
<strong>Namespace:</strong>
 <a href="c0250011-c1b9-bc9a-b501-96a9795f44a5.htm">Vanara.PInvoke</a><br />
<strong>Assembly:</strong>
 Vanara.PInvoke.TaskSchd (in Vanara.PInvoke.TaskSchd.dll) Version: 1.0.2<div class="collapsibleAreaRegion"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID1RB')" onkeypress="SectionExpandCollapse_CheckKey('ID1RB', event)" tabindex="0"><img id="ID1RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />Syntax</span></div><div id="ID1RBSection" class="collapsibleSection"><div class="codeSnippetContainer"><div class="codeSnippetContainerTabs"><div id="ID0EBCA_tab1" class="codeSnippetContainerTab"><a href="#" onclick="javascript:ChangeTab('ID0EBCA','cs','1','2');return false;">C#</a></div><div id="ID0EBCA_tab2" class="codeSnippetContainerTab"><a href="#" onclick="javascript:ChangeTab('ID0EBCA','vb','2','2');return false;">VB</a></div></div><div class="codeSnippetContainerCodeContainer"><div class="codeSnippetToolBar"><div class="codeSnippetToolBarText"><a id="ID0EBCA_copyCode" href="#" class="copyCodeSnippet" onclick="javascript:CopyToClipboard('ID0EBCA');return false;" title="Copy">Copy</a></div></div><div id="ID0EBCA_code_Div1" class="codeSnippetContainerCode" style="display: block"><pre xml:space="preserve"><span class="identifier">IEnumerator</span> <span class="identifier">GetEnumerator</span>()</pre></div><div id="ID0EBCA_code_Div2" class="codeSnippetContainerCode" style="display: none"><pre xml:space="preserve"><span class="keyword">Function</span> <span class="identifier">GetEnumerator</span> <span class="keyword">As</span> <span class="identifier">IEnumerator</span></pre></div></div></div><script type="text/javascript">AddLanguageTabSet("ID0EBCA");</script><h4 class="subHeading">Return Value</h4>Type: <a href="http://msdn2.microsoft.com/en-us/library/1t2267t6" target="_blank">IEnumerator</a><br />An <a href="http://msdn2.microsoft.com/en-us/library/1t2267t6" target="_blank">IEnumerator</a> object that can be used to iterate through the collection.<h4 class="subHeading">Implements</h4><a href="http://msdn2.microsoft.com/en-us/library/5zae5365" target="_blank">IEnumerable<span id="LSTF77BE5EE_2"></span><script type="text/javascript">AddLanguageSpecificTextSet("LSTF77BE5EE_2?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>GetEnumerator<span id="LSTF77BE5EE_3"></span><script type="text/javascript">AddLanguageSpecificTextSet("LSTF77BE5EE_3?cs=()|vb=|cpp=()|nu=()|fs=()");</script></a><br /></div><div class="collapsibleAreaRegion" id="seeAlsoSection"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID2RB')" onkeypress="SectionExpandCollapse_CheckKey('ID2RB', event)" tabindex="0"><img id="ID2RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />See Also</span></div><div id="ID2RBSection" class="collapsibleSection"><h4 class="subHeading">Reference</h4><div class="seeAlsoStyle"><a href="1068b4c3-da1d-b496-3e69-410f8d4c5a50.htm">TaskSchd<span id="LSTF77BE5EE_4"></span><script type="text/javascript">AddLanguageSpecificTextSet("LSTF77BE5EE_4?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>ITaskFolderCollection Interface</a></div><div class="seeAlsoStyle"><a href="c0250011-c1b9-bc9a-b501-96a9795f44a5.htm">Vanara.PInvoke Namespace</a></div></div></div></div><div id="pageFooter" class="pageFooter"> </div></body></html>

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

View File

@ -0,0 +1,5 @@
<html><head><meta http-equiv="X-UA-Compatible" content="IE=edge" /><link rel="shortcut icon" href="../icons/favicon.ico" /><link rel="stylesheet" type="text/css" href="../styles/branding.css" /><link rel="stylesheet" type="text/css" href="../styles/branding-en-US.css" /><script type="text/javascript" src="../scripts/branding.js"> </script><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>ThemedImageDraw.TranslateButtonState Event</title><meta name="Language" content="en-us" /><meta name="System.Keywords" content="TranslateButtonState event" /><meta name="System.Keywords" content="ThemedImageDraw.TranslateButtonState event" /><meta name="Microsoft.Help.F1" content="Vanara.Windows.Forms.ThemedImageDraw.TranslateButtonState" /><meta name="Microsoft.Help.Id" content="E:Vanara.Windows.Forms.ThemedImageDraw.TranslateButtonState" /><meta name="Description" content="summaryE:Vanara.Windows.Forms.ThemedImageDraw.TranslateButtonState" /><meta name="Microsoft.Help.ContentType" content="Reference" /><meta name="BrandingAware" content="true" /><meta name="container" content="Vanara.Windows.Forms" /><meta name="file" content="006bd8a1-d30e-39fb-cab3-af1ac095de1b" /><meta name="guid" content="006bd8a1-d30e-39fb-cab3-af1ac095de1b" /><link rel="stylesheet" type="text/css" href="../styles/branding-Website.css" /><script type="text/javascript" src="../scripts/jquery-1.11.0.min.js"></script><script type="text/javascript" src="../scripts/branding-Website.js"></script><script type="text/javascript" src="../scripts/clipboard.min.js"></script></head><body onload="OnLoad('cs')"><input type="hidden" id="userDataCache" class="userDataStyle" /><div class="pageHeader" id="PageHeader">Vanara API Documentation<form id="SearchForm" method="get" action="#" onsubmit="javascript:TransferToSearchPage(); return false;"><input id="SearchTextBox" type="text" maxlength="200" /><button id="SearchButton" type="submit"></button></form></div><div class="pageBody"><div class="leftNav" id="leftNav"><div id="tocNav"><div class="toclevel0" data-toclevel="0"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="d22522ce-4106-42b2-81eb-cb37a0f36df8.htm" title="Vanara API Documentation" tocid="roottoc">Vanara API Documentation</a></div><div class="toclevel0" data-toclevel="0"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="c580cf52-4028-70db-28d0-f9b1abc03861.htm" title="Vanara.Windows.Forms" tocid="c580cf52-4028-70db-28d0-f9b1abc03861">Vanara.Windows.Forms</a></div><div class="toclevel0" data-toclevel="0"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="8b4d3bb7-4bd8-b541-d9c6-0a2f0afa2c3d.htm" title="ThemedImageDraw Class" tocid="8b4d3bb7-4bd8-b541-d9c6-0a2f0afa2c3d">ThemedImageDraw Class</a></div><div class="toclevel1" data-toclevel="1" data-childrenloaded="true"><a class="tocExpanded" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="2369ffbd-da8a-4b02-80da-7be3d27e9940.htm" title="ThemedImageDraw Events" tocid="2369ffbd-da8a-4b02-80da-7be3d27e9940">ThemedImageDraw Events</a></div><div class="toclevel2 current" data-toclevel="2"><a data-tochassubtree="false" href="006bd8a1-d30e-39fb-cab3-af1ac095de1b.htm" title="TranslateButtonState Event" tocid="006bd8a1-d30e-39fb-cab3-af1ac095de1b">TranslateButtonState Event</a></div></div><div id="tocResizableEW" onmousedown="OnMouseDown(event);"></div><div id="TocResize" class="tocResize"><img id="ResizeImageIncrease" src="../icons/TocOpen.gif" onclick="OnIncreaseToc()" alt="Click or drag to resize" title="Click or drag to resize" /><img id="ResizeImageReset" src="../icons/TocClose.gif" style="display:none" onclick="OnResetToc()" alt="Click or drag to resize" title="Click or drag to resize" /></div></div><div class="topicContent" id="TopicContent"><table class="titleTable"><tr><td class="logoColumn"><img src="../icons/Help.png" /></td><td class="titleColumn"><h1>ThemedImageDraw<span id="LSTCC80FC50_0"></span><script type="text/javascript">AddLanguageSpecificTextSet("LSTCC80FC50_0?cpp=::|nu=.");</script>TranslateButtonState Event</h1></td></tr></table><span class="introStyle"></span> <div class="summary"><p style="color: #dc143c; font-size: 8.5pt; font-weight: bold;">[Missing &lt;summary&gt; documentation for "E:Vanara.Windows.Forms.ThemedImageDraw.TranslateButtonState"]</p></div><p> </p>
<strong>Namespace:</strong>
 <a href="c580cf52-4028-70db-28d0-f9b1abc03861.htm">Vanara.Windows.Forms</a><br />
<strong>Assembly:</strong>
 Vanara.UI (in Vanara.UI.dll) Version: 1.0.2<div class="collapsibleAreaRegion"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID1RB')" onkeypress="SectionExpandCollapse_CheckKey('ID1RB', event)" tabindex="0"><img id="ID1RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />Syntax</span></div><div id="ID1RBSection" class="collapsibleSection"><div class="codeSnippetContainer"><div class="codeSnippetContainerTabs"><div id="ID0EBCA_tab1" class="codeSnippetContainerTab"><a href="#" onclick="javascript:ChangeTab('ID0EBCA','cs','1','2');return false;">C#</a></div><div id="ID0EBCA_tab2" class="codeSnippetContainerTab"><a href="#" onclick="javascript:ChangeTab('ID0EBCA','vb','2','2');return false;">VB</a></div></div><div class="codeSnippetContainerCodeContainer"><div class="codeSnippetToolBar"><div class="codeSnippetToolBarText"><a id="ID0EBCA_copyCode" href="#" class="copyCodeSnippet" onclick="javascript:CopyToClipboard('ID0EBCA');return false;" title="Copy">Copy</a></div></div><div id="ID0EBCA_code_Div1" class="codeSnippetContainerCode" style="display: block"><pre xml:space="preserve"><span class="keyword">public</span> event <span class="identifier">TranslateButtonStateDelegate</span> <span class="identifier">TranslateButtonState</span></pre></div><div id="ID0EBCA_code_Div2" class="codeSnippetContainerCode" style="display: none"><pre xml:space="preserve"><span class="keyword">Public</span> Event <span class="identifier">TranslateButtonState</span> <span class="keyword">As</span> <span class="identifier">TranslateButtonStateDelegate</span></pre></div></div></div><script type="text/javascript">AddLanguageTabSet("ID0EBCA");</script><h4 class="subHeading">Value</h4>Type: <a href="669a397a-924b-65e5-d075-93f5d8bd7aea.htm">Vanara.Windows.Forms<span id="LSTCC80FC50_1"></span><script type="text/javascript">AddLanguageSpecificTextSet("LSTCC80FC50_1?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>TranslateButtonStateDelegate</a></div><div class="collapsibleAreaRegion" id="seeAlsoSection"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID2RB')" onkeypress="SectionExpandCollapse_CheckKey('ID2RB', event)" tabindex="0"><img id="ID2RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />See Also</span></div><div id="ID2RBSection" class="collapsibleSection"><h4 class="subHeading">Reference</h4><div class="seeAlsoStyle"><a href="8b4d3bb7-4bd8-b541-d9c6-0a2f0afa2c3d.htm">ThemedImageDraw Class</a></div><div class="seeAlsoStyle"><a href="c580cf52-4028-70db-28d0-f9b1abc03861.htm">Vanara.Windows.Forms Namespace</a></div></div></div></div><div id="pageFooter" class="pageFooter"> </div></body></html>

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

14
docs/index.html Normal file
View File

@ -0,0 +1,14 @@
<!DOCTYPE html>
<html lang="en-US">
<head>
<meta charset="UTF-8">
<meta http-equiv="refresh" content="1;url=html/d22522ce-4106-42b2-81eb-cb37a0f36df8.htm">
<script type="text/javascript">
window.location.replace("html/d22522ce-4106-42b2-81eb-cb37a0f36df8.htm")
</script>
<title>Vanara API Documentation - Redirect</title>
</head>
<body>
<p>If you are not redirected automatically, follow this link to the <a href="html/d22522ce-4106-42b2-81eb-cb37a0f36df8.htm">default topic</a>.</p>
</body>
</html>

35
docs/search.html Normal file
View File

@ -0,0 +1,35 @@
<!DOCTYPE html>
<html>
<head>
<title>Vanara API Documentation - Search</title>
<link rel="stylesheet" type="text/css" href="styles/branding.css" />
<link rel="stylesheet" type="text/css" href="styles/branding-Website.css" />
<script type="text/javascript" src="scripts/jquery-1.11.0.min.js"></script>
<script type="text/javascript" src="scripts/branding.js"></script>
<script type="text/javascript" src="scripts/branding-Website.js"></script>
</head>
<body onload="OnSearchPageLoad();">
<div class="pageHeader" id="PageHeader">
Vanara API Documentation - Search
</div>
<div class="pageBody">
<div class="searchContainer">
<div style="float: left;">
<form id="SearchForm" method="get" action="#" onsubmit="javascript:PerformSearch(); return false;">
<input id="txtSearchText" type="text" maxlength="200" />
<button id="HeaderSearchButton" type="submit" class="header-search-button">
</button>
</form>
</div>
&nbsp;&nbsp;<input type="checkbox" id="chkSortByTitle" onclick="javascript:PerformSearch();" />
Sort by title
<br />
<br />
<div id="searchResults">
</div>
<p>
<a href="html/d22522ce-4106-42b2-81eb-cb37a0f36df8.htm">Back</a></p>
</div>
</div>
</body>
</html>