IAcadUtility Interface Reference

import"FxInterfaces.idl";

Inheritance diagram for IAcadUtility:

Public Member Functions
HRESULT	AngleToReal ([in] BSTR Angle, [in] AcAngleUnits Unit, [out, retval] double *Value)
HRESULT	AngleToString ([in] double Angle, [in] AcAngleUnits Unit, [in] int precision, [out, retval] BSTR *bstrValue)
HRESULT	DistanceToReal ([in] BSTR Distance, [in] AcUnits Unit, [out, retval] double *Value)
HRESULT	RealToString ([in] double Value, [in] AcUnits Unit, [in] int precision, [out, retval] BSTR *bstrValue)
HRESULT	TranslateCoordinates ([in] VARIANT Point, [in] AcCoordinateSystem FromCoordSystem, [in] AcCoordinateSystem ToCoordSystem, [in] int Displacement, [in, optional] VARIANT OCSNormal, [out, retval] VARIANT *transPt)
HRESULT	InitializeUserInput ([in] int Bits, [in, optional] VARIANT KeyWordList)
HRESULT	GetInteger ([in, optional] VARIANT Prompt, [out, retval] int *Value)
HRESULT	GetReal ([in, optional] VARIANT Prompt, [out, retval] double *Value)
HRESULT	GetInput ([out, retval] BSTR *Value)
HRESULT	GetKeyword ([in, optional] VARIANT Prompt, [out, retval] BSTR *bstrKeyword)
HRESULT	GetString ([in] int HasSpaces, [in, optional] VARIANT Prompt, [out, retval] BSTR *bstrValue)
HRESULT	GetAngle ([in, optional] VARIANT Point, [in, optional] VARIANT Prompt, [out, retval] double *Angle)
HRESULT	AngleFromXAxis ([in] VARIANT StartPoint, [in] VARIANT EndPoint, [out, retval] double *Angle)
HRESULT	GetCorner ([in] VARIANT Point, [in, optional] VARIANT Prompt, [out, retval] VARIANT *corner)
HRESULT	GetDistance ([in, optional] VARIANT Point, [in, optional] VARIANT Prompt, [out, retval] double *dist)
HRESULT	GetOrientation ([in, optional] VARIANT Point, [in, optional] VARIANT Prompt, [out, retval] double *Angle)
HRESULT	GetPoint ([in, optional] VARIANT Point, [in, optional] VARIANT Prompt, [out, retval] VARIANT *inputPoint)
HRESULT	PolarPoint ([in] VARIANT Point, [in] double Angle, [in] double Distance, [out, retval] VARIANT *inputPoint)
HRESULT	CreateTypedArray ([out] VARIANT *varArr, [in] int Type, [in] SAFEARRAY(VARIANT) inArgs)
HRESULT	GetEntity ([out] IDispatch **Object, [out] VARIANT *PickedPoint, [in, optional] VARIANT Prompt)
HRESULT	Prompt ([in] BSTR Message)
HRESULT	GetSubEntity ([out] IDispatch **Object, [out] VARIANT *PickedPoint, [out] VARIANT *transMatrix, [out] VARIANT *ContextData, [in, optional] VARIANT Prompt)
HRESULT	IsURL ([in] BSTR URL, [out, retval] VARIANT_BOOL *IsValidURL)
HRESULT	GetRemoteFile ([in] BSTR URL, [out] BSTR *LocalFile, [in] VARIANT_BOOL IgnoreCache)
HRESULT	PutRemoteFile ([in] BSTR URL, [in] BSTR LocalFile)
HRESULT	IsRemoteFile ([in] BSTR LocalFile, [out] BSTR *URL, [out, retval] VARIANT_BOOL *IsDownloadedFile)
HRESULT	LaunchBrowserDialog ([out] BSTR *SelectedURL, [in] BSTR DialogTitle, [in] BSTR OpenButtonCaption, [in] BSTR StartPageURL, [in] BSTR RegistryRootKey, [in] VARIANT_BOOL OpenButtonAlwaysEnabled, [out, retval] VARIANT_BOOL *success)

Detailed Description

Definition at line 1203 of file FxInterfaces.idl.

Member Function Documentation

AngleFromXAxis()

HRESULT IAcadUtility::AngleFromXAxis	(	[in] VARIANT	StartPoint,
		[in] VARIANT	EndPoint,
		[out, retval] double *	Angle
	)

AngleToReal()

HRESULT IAcadUtility::AngleToReal	(	[in] BSTR	Angle,
		[in] AcAngleUnits	Unit,
		[out, retval] double *	Value
	)

AngleToString()

HRESULT IAcadUtility::AngleToString	(	[in] double	Angle,
		[in] AcAngleUnits	Unit,
		[in] int	precision,
		[out, retval] BSTR *	bstrValue
	)

CreateTypedArray()

HRESULT IAcadUtility::CreateTypedArray	(	[out] VARIANT *	varArr,
		[in] int	Type,
		[in] SAFEARRAY(VARIANT)	inArgs
	)

DistanceToReal()

HRESULT IAcadUtility::DistanceToReal	(	[in] BSTR	Distance,
		[in] AcUnits	Unit,
		[out, retval] double *	Value
	)

GetAngle()

HRESULT IAcadUtility::GetAngle	(	[in, optional] VARIANT	Point,
		[in, optional] VARIANT	Prompt,
		[out, retval] double *	Angle
	)

GetCorner()

HRESULT IAcadUtility::GetCorner	(	[in] VARIANT	Point,
		[in, optional] VARIANT	Prompt,
		[out, retval] VARIANT *	corner
	)

GetDistance()

HRESULT IAcadUtility::GetDistance	(	[in, optional] VARIANT	Point,
		[in, optional] VARIANT	Prompt,
		[out, retval] double *	dist
	)

GetEntity()

HRESULT IAcadUtility::GetEntity	(	[out] IDispatch **	Object,
		[out] VARIANT *	PickedPoint,
		[in, optional] VARIANT	Prompt
	)

GetInput()

HRESULT IAcadUtility::GetInput

(

[out, retval] BSTR *

Value

)

GetInteger()

HRESULT IAcadUtility::GetInteger	(	[in, optional] VARIANT	Prompt,
		[out, retval] int *	Value
	)

GetKeyword()

HRESULT IAcadUtility::GetKeyword	(	[in, optional] VARIANT	Prompt,
		[out, retval] BSTR *	bstrKeyword
	)

GetOrientation()

HRESULT IAcadUtility::GetOrientation	(	[in, optional] VARIANT	Point,
		[in, optional] VARIANT	Prompt,
		[out, retval] double *	Angle
	)

GetPoint()

HRESULT IAcadUtility::GetPoint	(	[in, optional] VARIANT	Point,
		[in, optional] VARIANT	Prompt,
		[out, retval] VARIANT *	inputPoint
	)

GetReal()

HRESULT IAcadUtility::GetReal	(	[in, optional] VARIANT	Prompt,
		[out, retval] double *	Value
	)

GetRemoteFile()

HRESULT IAcadUtility::GetRemoteFile	(	[in] BSTR	URL,
		[out] BSTR *	LocalFile,
		[in] VARIANT_BOOL	IgnoreCache
	)

GetString()

HRESULT IAcadUtility::GetString	(	[in] int	HasSpaces,
		[in, optional] VARIANT	Prompt,
		[out, retval] BSTR *	bstrValue
	)

GetSubEntity()

HRESULT IAcadUtility::GetSubEntity	(	[out] IDispatch **	Object,
		[out] VARIANT *	PickedPoint,
		[out] VARIANT *	transMatrix,
		[out] VARIANT *	ContextData,
		[in, optional] VARIANT	Prompt
	)

InitializeUserInput()

HRESULT IAcadUtility::InitializeUserInput	(	[in] int	Bits,
		[in, optional] VARIANT	KeyWordList
	)

IsRemoteFile()

HRESULT IAcadUtility::IsRemoteFile	(	[in] BSTR	LocalFile,
		[out] BSTR *	URL,
		[out, retval] VARIANT_BOOL *	IsDownloadedFile
	)

IsURL()

HRESULT IAcadUtility::IsURL	(	[in] BSTR	URL,
		[out, retval] VARIANT_BOOL *	IsValidURL
	)

LaunchBrowserDialog()

HRESULT IAcadUtility::LaunchBrowserDialog	(	[out] BSTR *	SelectedURL,
		[in] BSTR	DialogTitle,
		[in] BSTR	OpenButtonCaption,
		[in] BSTR	StartPageURL,
		[in] BSTR	RegistryRootKey,
		[in] VARIANT_BOOL	OpenButtonAlwaysEnabled,
		[out, retval] VARIANT_BOOL *	success
	)

PolarPoint()

HRESULT IAcadUtility::PolarPoint	(	[in] VARIANT	Point,
		[in] double	Angle,
		[in] double	Distance,
		[out, retval] VARIANT *	inputPoint
	)

Prompt()

HRESULT IAcadUtility::Prompt

(

[in] BSTR

Message

)

PutRemoteFile()

HRESULT IAcadUtility::PutRemoteFile	(	[in] BSTR	URL,
		[in] BSTR	LocalFile
	)

RealToString()

HRESULT IAcadUtility::RealToString	(	[in] double	Value,
		[in] AcUnits	Unit,
		[in] int	precision,
		[out, retval] BSTR *	bstrValue
	)

TranslateCoordinates()

HRESULT IAcadUtility::TranslateCoordinates	(	[in] VARIANT	Point,
		[in] AcCoordinateSystem	FromCoordSystem,
		[in] AcCoordinateSystem	ToCoordSystem,
		[in] int	Displacement,
		[in, optional] VARIANT	OCSNormal,
		[out, retval] VARIANT *	transPt
	)

---

The documentation for this interface was generated from the following file:

• FxInterfaces.idl